Create a custom storage credential

POST 
/custom_storage_credentials/:connection_id

Creates a custom storage credentials configuration.

Request

Path Parameters

connection_id stringrequired

Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection resource.

application/json

Body

required

Creates new credentials resource for given connection_id.

backend stringrequired

Possible values: [gcs, s3, azure]

configuration

object

required

oneOf

• Google Cloud Storage Configuration Data
• AWS S3 Storage Configuration Data
• Azure Blob Storage Configuration Data

credentials password

Opaque credential token used to authenticate and authorize with storage provider.

bucket Bucket (string)

Name of the bucket to be used to store recording files.

bucket Bucket (string)

Name of the bucket to be used to store recording files.

region Region (string)

Region where the bucket is located.

aws_access_key_id AwsAccessKeyId (string)

AWS credentials access key id.

aws_secret_access_key AwsSecretAccessKey (string)

AWS secret access key.

bucket Bucket (string)

Name of the bucket to be used to store recording files.

account_name AzureAccountName (string)

Azure Blob Storage account name

account_key AzureAccountKey (string)

Azure Blob Storage account key

Responses

200: A response with credentials resource.

application/json

• Schema
• Example (from schema)

Schema

data

object

required

backend stringrequired

Possible values: [gcs, s3, azure]

configuration

object

required

oneOf

• Google Cloud Storage Configuration Data
• AWS S3 Storage Configuration Data
• Azure Blob Storage Configuration Data

credentials password

Opaque credential token used to authenticate and authorize with storage provider.

bucket Bucket (string)

Name of the bucket to be used to store recording files.

bucket Bucket (string)

Name of the bucket to be used to store recording files.

region Region (string)

Region where the bucket is located.

aws_access_key_id AwsAccessKeyId (string)

AWS credentials access key id.

aws_secret_access_key AwsSecretAccessKey (string)

AWS secret access key.

bucket Bucket (string)

Name of the bucket to be used to store recording files.

account_name AzureAccountName (string)

Azure Blob Storage account name

account_key AzureAccountKey (string)

Azure Blob Storage account key

connection_id required

Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection resource.

record_type RecordType (string)required

Possible values: Value must match regular expression custom_storage_credentials

Identifies record type.

{
  "data": {
    "backend": "gcs",
    "configuration": {}
  },
  "record_type": "string"
}

default: Unexpected error.

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code integerrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/custom_storage_credentials/:connection_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "backend": "gcs",
  "configuration": {
    "credentials": "OPAQUE_CREDENTIALS_TOKEN",
    "bucket": "example-bucket"
  }
}'

Response samples

• 200
• default

---

{
  "data": {
    "backend": "gcs",
    "configuration": {}
  },
  "record_type": "string"
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}