Skip to main content
PATCH
/
v5
/
credentials
/
{credential_id}
Update Credential
curl --request PATCH \
  --url https://api.egp.scale.com/v5/credentials/{credential_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "type": "<string>",
  "payload": "<string>",
  "credential_metadata": {}
}
'
{
  "id": "<string>",
  "created_by_user_id": "<string>",
  "created_by_identity_type": "<string>",
  "type": "<string>",
  "name": "<string>",
  "description": "<string>",
  "credential_metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "object": "credential"
}

Documentation Index

Fetch the complete documentation index at: https://docs.gp.scale.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Headers

​
x-selected-account-id
string | null

Path Parameters

​
credential_id
string
required

Body

application/json
​
name
string

User-friendly name for the credential

​
description
string

Optional description

​
type
string

Type of credential: key or json

​
payload
string<password>
write-only

The credential payload to be encrypted

​
credential_metadata
Credential Metadata · object

Optional unencrypted credential_metadata

Response

Successful Response

​
id
string
required
​
created_by_user_id
string
required
​
created_by_identity_type
string
required
​
type
string
required
​
name
string
required
​
description
string
required
​
credential_metadata
Credential Metadata · object
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
object
string
default:credential