Twilio Segment logo

Credentials

Operations related to Credentials

Create Credential

Creates a new Credential.

Securitytoken
Request
Request Body schema:
required
name
required
string (name)

A human-readable name for this Credential.

required
object (settings)

A key-value object that contains type-specific settings for this Credential.

settings.type is required and determines the Credential type (for example Snowflake or Redshift). Different types require different settings; see the settings.type discriminator in the OpenAPI spec for the full set of required and optional fields per type.

Responses
201

Created

404

Resource not found

422

Validation failure

429

Too many requests

post/credentials
Request samples
{
  • "name": "Production Snowflake",
  • "settings": {
    }
}
Response samples
{
  • "data": {
    }
}

Update Credential

Updates an existing Credential. All Warehouses using this Credential are affected immediately.

Securitytoken
Request
path Parameters
credentialId
required
string [ 1 .. 255 ]
Example: cred_2JzKWb8FGhGVYZ3xVqQGc7NkYPl
Request Body schema:
required
name
string (name)

An optional human-readable name to associate with this Credential.

object (settings)

A key-value object that contains type-specific settings for this Credential.

Supports partial updates — only the fields you want to change need to be provided. settings.type cannot be changed.

Responses
200

OK

404

Resource not found

422

Validation failure

429

Too many requests

patch/credentials/{credentialId}
Request samples
{
  • "name": "Updated Snowflake Prod",
  • "settings": {
    }
}
Response samples
{
  • "data": {
    }
}
➔ Next to dbt