secure
secret-providers

Upsert Secret Provider By Name

Changed on

Upserts a secret-provider in RDI settings by its name.

put/api/v1/pipelines/secret-providers/{name}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/pipelines/secret-providers/{name}
  • Auth
    HTTP bearer

Path parameters

namestring required

Request body

object required

Example request

{
  "type": "vault",
  "parameters": {
    "vaultAddress": "http://vault.default:8200",
    "roleName": "database",
    "someField": "abc",
    "objects": [
      {
        "objectName": "password",
        "secretPath": "secret/data/db-pass",
        "secretKey": "password"
      }
    ]
  }
}

Response

Successful Response

action_idstring nullable

Example response

{
  "action_id": "1234567890"
}

Changes

    • breaking

      the response's body type changed from no type to object for status

    • info

      removed from the response body anyOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      removed the non-success response with the status