Documentation | Credentials › Get Credential Secret By ID

credentials

Methods

Create Credential ->

post/v5/credentials

Create a new credential for storing sensitive data like API keys, tokens, or other secrets.

Get Credential By ID ->

get/v5/credentials/{credential_id}

Retrieve a specific credential by its unique identifier.

Get Credential By Name ->

get/v5/credentials/name/{credential_name}

Retrieve a specific credential by its name.

Get Credential Secret By ID ->

post/v5/credentials/{credential_id}/secret

Retrieve the plaintext payload of a credential by its ID.

path Parameters

credential_id: string

Response fields

Request example

curl https://api.egp.scale.com/v5/credentials/$CREDENTIAL_ID/secret \
    -X POST \
    -H "x-api-key: $SGP_API_KEY"

200Example

{
  "result": "result",
  "object": "object"
}

Get Credential Secret By Name ->

post/v5/credentials/name/{credential_name}/secret

Retrieve the plaintext payload of a credential by its name.

List Credentials -> CursorPage<

get/v5/credentials

Retrieve a paginated list of all credentials for the current account with optional name filtering.

Update Credential ->

patch/v5/credentials/{credential_id}

Update an existing credential's properties including name, description, type, payload, and metadata.

Delete Credential -> { id, deleted, object }

delete/v5/credentials/{credential_id}

Permanently delete a credential and all its associated data.

Domain types

Credential = { id, created_at, created_by_identity_type, 7 more... }

CredentialSecret = { result, object }