Provider Credentials

6 operations.

Method	Endpoint	Description
GET	`/api/v1/organizations/{organizationIdOrSlug}/provider-credentials`	List provider credentials
POST	`/api/v1/organizations/{organizationIdOrSlug}/provider-credentials`	Create a provider credential
GET	`/api/v1/organizations/{organizationIdOrSlug}/provider-credentials/{credentialId}`	Get a provider credential
PATCH	`/api/v1/organizations/{organizationIdOrSlug}/provider-credentials/{credentialId}`	Update a provider credential
DELETE	`/api/v1/organizations/{organizationIdOrSlug}/provider-credentials/{credentialId}`	Delete a provider credential
POST	`/api/v1/organizations/{organizationIdOrSlug}/provider-credentials/{credentialId}/versions`	Rotate a provider credential

List provider credentials

GET /api/v1/organizations/{organizationIdOrSlug}/provider-credentials

Parameters

path

Name	Type	Required	Description
`organizationIdOrSlug`	`one of 2 types`	required	Identifies the organization by its stable identifier or slug. Applies to List provider credentials.

Responses

Status	Description	Body
`200`	Response for status 200	`application/json` — `object` — data: object (required)
`400`	The request is malformed or cannot be processed.	`application/json` — `PublicApiError` — error: object (required)
`401`	Authentication failed. The Authorization header is missing, or the credential is invalid or expired.	`application/json` — `PublicApiError` — error: object (required)
`403`	Access denied. The authenticated user does not have permission to perform this action.	`application/json` — `PublicApiError` — error: object (required)
`404`	Resource not found.	`application/json` — `PublicApiError` — error: object (required)
`409`	Request conflicts with current state of the resource, including safe deployment conflict classifications.	`application/json` — `PublicApiError` — error: object (required)
`422`	Request validation failed. Check the request body, query parameters, or path parameters.	`application/json` — `PublicApiError` — error: object (required)
`429`	Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying.	`application/json` — `PublicApiError` — error: object (required)
`500`	The server could not complete the request.	`application/json` — `PublicApiError` — error: object (required)
`503`	Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.	`application/json` — `PublicApiError` — error: object (required)

Create a provider credential

POST /api/v1/organizations/{organizationIdOrSlug}/provider-credentials

Parameters

path

Name	Type	Required	Description
`organizationIdOrSlug`	`one of 2 types`	required	Identifies the organization by its stable identifier or slug. Applies to Create a provider credential.

Request body

Required — Request body for: Create a provider credential.

application/json

Name	Type	Required
`label`	`string`	required
`provider`	`one of 2 types`	required
`credentialType`	`"api_key" \| "oauth" \| "service_account" \| "connection_string"`	required
`secret`	`string`	required
`expiresAt`	`string \| null`	optional

Responses

Status	Description	Body
`200`	Response for status 200	`application/json` — `object` — data: object (required)
`400`	The request is malformed or cannot be processed.	`application/json` — `PublicApiError` — error: object (required)
`401`	Authentication failed. The Authorization header is missing, or the credential is invalid or expired.	`application/json` — `PublicApiError` — error: object (required)
`403`	Access denied. The authenticated user does not have permission to perform this action.	`application/json` — `PublicApiError` — error: object (required)
`404`	Resource not found.	`application/json` — `PublicApiError` — error: object (required)
`409`	Request conflicts with current state of the resource, including safe deployment conflict classifications.	`application/json` — `PublicApiError` — error: object (required)
`422`	Request validation failed. Check the request body, query parameters, or path parameters.	`application/json` — `PublicApiError` — error: object (required)
`429`	Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying.	`application/json` — `PublicApiError` — error: object (required)
`500`	The server could not complete the request.	`application/json` — `PublicApiError` — error: object (required)
`503`	Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.	`application/json` — `PublicApiError` — error: object (required)

Get a provider credential

GET /api/v1/organizations/{organizationIdOrSlug}/provider-credentials/{credentialId}

Parameters

path

Name	Type	Required	Description
`organizationIdOrSlug`	`one of 2 types`	required	Identifies the organization by its stable identifier or slug. Applies to Get a provider credential.
`credentialId`	`string`	required	Identifies the provider credential being addressed. Applies to Get a provider credential.

Responses

Status	Description	Body
`200`	Response for status 200	`application/json` — `object` — data: object (required)
`400`	The request is malformed or cannot be processed.	`application/json` — `PublicApiError` — error: object (required)
`401`	Authentication failed. The Authorization header is missing, or the credential is invalid or expired.	`application/json` — `PublicApiError` — error: object (required)
`403`	Access denied. The authenticated user does not have permission to perform this action.	`application/json` — `PublicApiError` — error: object (required)
`404`	Resource not found.	`application/json` — `PublicApiError` — error: object (required)
`409`	Request conflicts with current state of the resource, including safe deployment conflict classifications.	`application/json` — `PublicApiError` — error: object (required)
`422`	Request validation failed. Check the request body, query parameters, or path parameters.	`application/json` — `PublicApiError` — error: object (required)
`429`	Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying.	`application/json` — `PublicApiError` — error: object (required)
`500`	The server could not complete the request.	`application/json` — `PublicApiError` — error: object (required)
`503`	Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.	`application/json` — `PublicApiError` — error: object (required)

Update a provider credential

PATCH /api/v1/organizations/{organizationIdOrSlug}/provider-credentials/{credentialId}

Parameters

path

Name	Type	Required	Description
`organizationIdOrSlug`	`one of 2 types`	required	Identifies the organization by its stable identifier or slug. Applies to Update a provider credential.
`credentialId`	`string`	required	Identifies the provider credential being addressed. Applies to Update a provider credential.

Request body

Required — Request body for: Update a provider credential.

application/json

Name	Type	Required
`label`	`string`	optional
`status`	`"active" \| "disabled" \| "deleting"`	optional
`expiresAt`	`string \| null`	optional

Responses

Status	Description	Body
`200`	Response for status 200	`application/json` — `object` — data: object (required)
`400`	The request is malformed or cannot be processed.	`application/json` — `PublicApiError` — error: object (required)
`401`	Authentication failed. The Authorization header is missing, or the credential is invalid or expired.	`application/json` — `PublicApiError` — error: object (required)
`403`	Access denied. The authenticated user does not have permission to perform this action.	`application/json` — `PublicApiError` — error: object (required)
`404`	Resource not found.	`application/json` — `PublicApiError` — error: object (required)
`409`	Request conflicts with current state of the resource, including safe deployment conflict classifications.	`application/json` — `PublicApiError` — error: object (required)
`422`	Request validation failed. Check the request body, query parameters, or path parameters.	`application/json` — `PublicApiError` — error: object (required)
`429`	Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying.	`application/json` — `PublicApiError` — error: object (required)
`500`	The server could not complete the request.	`application/json` — `PublicApiError` — error: object (required)
`503`	Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.	`application/json` — `PublicApiError` — error: object (required)

Delete a provider credential

DELETE /api/v1/organizations/{organizationIdOrSlug}/provider-credentials/{credentialId}

Parameters

path

Name	Type	Required	Description
`organizationIdOrSlug`	`one of 2 types`	required	Identifies the organization by its stable identifier or slug. Applies to Delete a provider credential.
`credentialId`	`string`	required	Identifies the provider credential being addressed. Applies to Delete a provider credential.

Responses

Status	Description	Body
`204`	Response for status 204	none — `none`
`400`	The request is malformed or cannot be processed.	`application/json` — `PublicApiError` — error: object (required)
`401`	Authentication failed. The Authorization header is missing, or the credential is invalid or expired.	`application/json` — `PublicApiError` — error: object (required)
`403`	Access denied. The authenticated user does not have permission to perform this action.	`application/json` — `PublicApiError` — error: object (required)
`404`	Resource not found.	`application/json` — `PublicApiError` — error: object (required)
`409`	Request conflicts with current state of the resource, including safe deployment conflict classifications.	`application/json` — `PublicApiError` — error: object (required)
`422`	Request validation failed. Check the request body, query parameters, or path parameters.	`application/json` — `PublicApiError` — error: object (required)
`429`	Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying.	`application/json` — `PublicApiError` — error: object (required)
`500`	The server could not complete the request.	`application/json` — `PublicApiError` — error: object (required)
`503`	Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.	`application/json` — `PublicApiError` — error: object (required)

Rotate a provider credential

POST /api/v1/organizations/{organizationIdOrSlug}/provider-credentials/{credentialId}/versions

Parameters

path

Name	Type	Required	Description
`organizationIdOrSlug`	`one of 2 types`	required	Identifies the organization by its stable identifier or slug. Applies to Rotate a provider credential.
`credentialId`	`string`	required	Identifies the provider credential being addressed. Applies to Rotate a provider credential.

Request body

Required — Request body for: Rotate a provider credential.

application/json

Name	Type	Required	Description
`secret`	`string`	required

Responses

Status	Description	Body
`200`	Response for status 200	`application/json` — `object` — data: object (required)
`400`	The request is malformed or cannot be processed.	`application/json` — `PublicApiError` — error: object (required)
`401`	Authentication failed. The Authorization header is missing, or the credential is invalid or expired.	`application/json` — `PublicApiError` — error: object (required)
`403`	Access denied. The authenticated user does not have permission to perform this action.	`application/json` — `PublicApiError` — error: object (required)
`404`	Resource not found.	`application/json` — `PublicApiError` — error: object (required)
`409`	Request conflicts with current state of the resource, including safe deployment conflict classifications.	`application/json` — `PublicApiError` — error: object (required)
`422`	Request validation failed. Check the request body, query parameters, or path parameters.	`application/json` — `PublicApiError` — error: object (required)
`429`	Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying.	`application/json` — `PublicApiError` — error: object (required)
`500`	The server could not complete the request.	`application/json` — `PublicApiError` — error: object (required)
`503`	Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.	`application/json` — `PublicApiError` — error: object (required)