{
  "opencollection": "1.0.0",
  "info": {
    "name": "Managed Database for PostgreSQL and MySQL Access Control List Secrets API",
    "version": "v1"
  },
  "items": [
    {
      "info": {
        "name": "Secrets",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List secrets",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.scaleway.com/secret-manager/v1beta1/regions/:region/secrets",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "organization_id",
                "value": "",
                "type": "query",
                "description": "Filter by Organization ID (optional). (UUID format)"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "query",
                "description": "Filter by Project ID (optional). (UUID format)"
              },
              {
                "name": "order_by",
                "value": "",
                "type": "query"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query"
              },
              {
                "name": "tags",
                "value": "",
                "type": "query",
                "description": "List of tags to filter on (optional)."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Filter by secret name (optional)."
              },
              {
                "name": "path",
                "value": "",
                "type": "query",
                "description": "Filter by exact path (optional)."
              },
              {
                "name": "ephemeral",
                "value": "",
                "type": "query",
                "description": "Filter by ephemeral / not ephemeral (optional)."
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Filter by secret type (optional)."
              },
              {
                "name": "scheduled_for_deletion",
                "value": "",
                "type": "query",
                "description": "Filter by whether the secret was scheduled for deletion / not scheduled for deletion. By default, it will display only not scheduled for deletion secrets."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve the list of secrets created within an Organization and/or Project. You must specify either the `organization_id` or the `project_id` and the `region`."
        },
        {
          "info": {
            "name": "Create a secret",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/secret-manager/v1beta1/regions/:region/secrets",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Create a secret in a given region specified by the `region` parameter."
        },
        {
          "info": {
            "name": "Get metadata using the secret's ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.scaleway.com/secret-manager/v1beta1/regions/:region/secrets/:secret_id",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "secret_id",
                "value": "",
                "type": "path",
                "description": "ID of the secret. (UUID format)"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve the metadata of a secret specified by the `region` and `secret_id` parameters."
        },
        {
          "info": {
            "name": "Update metadata of a secret",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.scaleway.com/secret-manager/v1beta1/regions/:region/secrets/:secret_id",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "secret_id",
                "value": "",
                "type": "path",
                "description": "ID of the secret. (UUID format)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Edit a secret's metadata such as name, tag(s), description and ephemeral policy. The secret to update is specified by the `secret_id` and `region` parameters."
        },
        {
          "info": {
            "name": "Delete a secret",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.scaleway.com/secret-manager/v1beta1/regions/:region/secrets/:secret_id",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "secret_id",
                "value": "",
                "type": "path",
                "description": "ID of the secret. (UUID format)"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Delete a given secret specified by the `region` and `secret_id` parameters."
        },
        {
          "info": {
            "name": "Allow a product to use the secret",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/secret-manager/v1beta1/regions/:region/secrets/:secret_id/add-owner",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "secret_id",
                "value": "",
                "type": "path",
                "description": "ID of the secret. (UUID format)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Allow a product to use the secret"
        },
        {
          "info": {
            "name": "Enable secret protection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/secret-manager/v1beta1/regions/:region/secrets/:secret_id/protect",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "secret_id",
                "value": "",
                "type": "path",
                "description": "ID of the secret to enable secret protection for. (UUID format)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Enable secret protection for a given secret specified by the `secret_id` parameter. Enabling secret protection means that your secret can be read and modified, but it cannot be deleted."
        },
        {
          "info": {
            "name": "Restore a secret",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/secret-manager/v1beta1/regions/:region/secrets/:secret_id/restore",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "secret_id",
                "value": "",
                "type": "path",
                "description": "(UUID format)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Restore a secret and all its versions scheduled for deletion specified by the `region` and `secret_id` parameters."
        },
        {
          "info": {
            "name": "Disable secret protection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/secret-manager/v1beta1/regions/:region/secrets/:secret_id/unprotect",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "secret_id",
                "value": "",
                "type": "path",
                "description": "ID of the secret to disable secret protection for. (UUID format)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Disable secret protection for a given secret specified by the `secret_id` parameter. Disabling secret protection means that your secret can be read, modified and deleted."
        },
        {
          "info": {
            "name": "Restore a version",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/secret-manager/v1beta1/regions/:region/secrets/:secret_id/versions/:revision/restore",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "secret_id",
                "value": "",
                "type": "path",
                "description": "(UUID format)"
              },
              {
                "name": "revision",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Restore a secret's version specified by the `region`, `secret_id` and `revision` parameters."
        }
      ]
    }
  ],
  "bundled": true
}