Set Credential

PUT

/api/v3/projects/{project_id}/credentials/{requirement_name}

curl --request PUT \
  --url https://example.com/api/v3/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/credentials/example \
  --header 'Content-Type: application/json' \
  --data '{ "value": "example" }'

Install or rotate one encrypted logical Project credential.

Parameters

Path Parameters

project_id

required

Project Id

string format: uuid

requirement_name

required

Requirement Name

string

Header Parameters

X-Admin-Key

Any of:

string

string

null

null

Request Body^required

Media typeapplication/json

CredentialSetRequestV3

Secret-bearing transport input accepted only over authenticated HTTPS.

object

value

required

Value

string format: password

Example^generated

{
  "value": "example"
}

Responses

200

Successful Response

Media typeapplication/json

CredentialBindingResponseV3

Secret-free status for one Project-wide credential binding.

object

created_at

required

Created At

string format: date-time

credential_kind

required

Credential Kind

string

id

required

Id

string format: uuid

last_verified_at

Any of:

string

string format: date-time

null

null

provider

required

Provider

string

rearmed_operation_ids

Rearmed Operation Ids

Array<string>

requirement_id

required

Requirement Id

string format: uuid

requirement_name

required

Requirement Name

string

scopes

Scopes

Array<string>

status

required

Status

string

updated_at

required

Updated At

string format: date-time

verification

Verification

object

key

additional properties

any

Example^generated

{
  "created_at": "2026-04-15T12:00:00Z",
  "credential_kind": "example",
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "last_verified_at": "2026-04-15T12:00:00Z",
  "provider": "example",
  "rearmed_operation_ids": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "requirement_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "requirement_name": "example",
  "scopes": [
    "example"
  ],
  "status": "example",
  "updated_at": "2026-04-15T12:00:00Z",
  "verification": {}
}

401

Authentication failed with a resumable next action.

Media typeapplication/json

ManagementErrorEnvelope

FastAPI error envelope shared by v3 management endpoints.

object

detail

required

ManagementErrorResponse

One bounded error with a coding-agent-safe recovery action.

object

affected_resource

Any of:

string

string

null

null

message

required

Message

string

next_action

Any of:

string

string

null

null

operation_id

Any of:

string

string format: uuid

null

null

phase

Any of:

string

string

null

null

reason_code

required

Reason Code

string

Example^generated

{
  "detail": {
    "affected_resource": "example",
    "message": "example",
    "next_action": "example",
    "operation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "phase": "example",
    "reason_code": "example"
  }
}

403

The authenticated actor lacks the required Project authority.

Media typeapplication/json

ManagementErrorEnvelope

FastAPI error envelope shared by v3 management endpoints.

object

detail

required

ManagementErrorResponse

One bounded error with a coding-agent-safe recovery action.

object

affected_resource

Any of:

string

string

null

null

message

required

Message

string

next_action

Any of:

string

string

null

null

operation_id

Any of:

string

string format: uuid

null

null

phase

Any of:

string

string

null

null

reason_code

required

Reason Code

string

Example^generated

{
  "detail": {
    "affected_resource": "example",
    "message": "example",
    "next_action": "example",
    "operation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "phase": "example",
    "reason_code": "example"
  }
}

404

The scoped management resource was not found.

Media typeapplication/json

ManagementErrorEnvelope

FastAPI error envelope shared by v3 management endpoints.

object

detail

required

ManagementErrorResponse

One bounded error with a coding-agent-safe recovery action.

object

affected_resource

Any of:

string

string

null

null

message

required

Message

string

next_action

Any of:

string

string

null

null

operation_id

Any of:

string

string format: uuid

null

null

phase

Any of:

string

string

null

null

reason_code

required

Reason Code

string

Example^generated

{
  "detail": {
    "affected_resource": "example",
    "message": "example",
    "next_action": "example",
    "operation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "phase": "example",
    "reason_code": "example"
  }
}

409

A stable management invariant prevented progress.

Media typeapplication/json

ManagementErrorEnvelope

FastAPI error envelope shared by v3 management endpoints.

object

detail

required

ManagementErrorResponse

One bounded error with a coding-agent-safe recovery action.

object

affected_resource

Any of:

string

string

null

null

message

required

Message

string

next_action

Any of:

string

string

null

null

operation_id

Any of:

string

string format: uuid

null

null

phase

Any of:

string

string

null

null

reason_code

required

Reason Code

string

Example^generated

{
  "detail": {
    "affected_resource": "example",
    "message": "example",
    "next_action": "example",
    "operation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "phase": "example",
    "reason_code": "example"
  }
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}