Skip to main content
PATCH
/
credentials
/
{idOrName}
{
  "environment_id": "ENV01FXJJFRNH8J1RBX7CCV2APD1M",
  "id": "CRD01FXJJFRNH8J1RBX7CCV2APD1O",
  "name": "production_database",
  "type": "aws",
  "created_at": "2023-11-07T05:31:56Z",
  "access_key_id": "AKIAIOSFODNN7EXAMPLE",
  "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRsiCYEXAMPLEKEY"
}

Path Parameters

​
idOrName
string
required

The ID or name of the credential to update.

Body

application/json

The updated credential data.

  • AWS
  • Basic Auth
  • ClickHouse
  • Kafka
  • PostgreSQL
  • Snowflake
​
access_key_id
string
Example:

"AKIAIOSFODNN7EXAMPLE"

​
secret_access_key
string
Example:

"wJalrXUtnFEMI/K7MDENG/bPxRsiCYEXAMPLEKEY"

​
name
string | null
Example:

"production_database"

Response

200 - application/json

The request has succeeded.

  • AWS
  • Basic Auth
  • ClickHouse
  • Kafka
  • PostgreSQL
  • Snowflake
​
type
enum<string>
required
Available options:
aws
​
access_key_id
string
required
Example:

"AKIAIOSFODNN7EXAMPLE"

​
secret_access_key
string
required
Example:

"wJalrXUtnFEMI/K7MDENG/bPxRsiCYEXAMPLEKEY"

​
environment_id
string
required
Example:

"ENV01FXJJFRNH8J1RBX7CCV2APD1M"

​
id
string
required
Example:

"CRD01FXJJFRNH8J1RBX7CCV2APD1O"

​
name
string | null
required
Example:

"production_database"

​
created_at
string<date-time>
required