{
  "opencollection": "1.0.0",
  "info": {
    "name": "Qovery Account Info Job Secret API",
    "version": "1.0.4"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Job Secret",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List job secrets",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.qovery.com/job/:jobId/secret",
            "params": [
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "Job ID"
              }
            ]
          },
          "docs": "Secrets are like environment variables, but they are secured and can't be revealed."
        },
        {
          "info": {
            "name": "Add a secret to the job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.qovery.com/job/:jobId/secret",
            "params": [
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "Job ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "- Add a secret to the job.\n"
        },
        {
          "info": {
            "name": "Edit a secret belonging to the job",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.qovery.com/job/:jobId/secret/:secretId",
            "params": [
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "Job ID"
              },
              {
                "name": "secretId",
                "value": "",
                "type": "path",
                "description": "Secret ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "- You can't edit a BUILT_IN secret\n- For an override, you can't edit the key\n- For an alias, you can't edit the value\n- An override can only have a scope lower to the secret it is overriding (hierarchy is BUILT_IN > PROJECT > ENVIRONMENT > CONTAINER)\n"
        },
        {
          "info": {
            "name": "Delete a secret from an job",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.qovery.com/job/:jobId/secret/:secretId",
            "params": [
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "Job ID"
              },
              {
                "name": "secretId",
                "value": "",
                "type": "path",
                "description": "Secret ID"
              }
            ]
          },
          "docs": "- To delete a secret you must have the project user permission\n- You can't delete a BUILT_IN secret\n- If you delete a secret having override or alias, the associated override/alias will be deleted as well\n"
        },
        {
          "info": {
            "name": "Create a secret override at the job level",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.qovery.com/job/:jobId/secret/:secretId/override",
            "params": [
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "Job ID"
              },
              {
                "name": "secretId",
                "value": "",
                "type": "path",
                "description": "Secret ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "- Allows you to override at job level a secret that has a higher scope.\n- You only have to specify a value in the request body\n- The system will create a new secret at job level with the same key as the one corresponding to the secret id in the path\n- The response body will contain the newly created secret\n- Information regarding the overridden_secret will be exposed in the \"overridden_secret\" field of the newly created secret\n"
        },
        {
          "info": {
            "name": "Create a secret alias at the job level",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.qovery.com/job/:jobId/secret/:secretId/alias",
            "params": [
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "Job ID"
              },
              {
                "name": "secretId",
                "value": "",
                "type": "path",
                "description": "Secret ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "- Allows you to add an alias at job level on an existing secret having higher scope, in order to customize its key.\n- You only have to specify a key in the request body\n- The system will create a new secret at job level with the same value as the one corresponding to the secret id in the path\n- The response body will contain the newly created secret\n- Information regarding the aliased_secret will be exposed in the \"aliased_secret\" field of the newly created secret\n- You can't create an alias on "
        }
      ]
    }
  ],
  "bundled": true
}