Skip to main content

Create a credential

POST 
/telephony_credentials

Create a credential.

Request

Body

required

Parameters that can be defined during credential creation

    name string
    tag string

    Tags a credential. A single tag can hold at maximum 1000 credentials.

    connection_id stringrequired

    Identifies the Credential Connection this credential is associated with.

    expires_at string

    ISO-8601 formatted date indicating when the credential will expire.

Responses

201: Successful response with details about a credential

422: Bad request

Request samples


curl -L 'https://api.telnyx.com/v2/telephony_credentials' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"name": "My-new-credential",
"connection_id": "1234567890"
}'

Response samples


{
"data": {
"id": "c215ade3-0d39-418e-94be-c5f780760199",
"record_type": "credential",
"name": "2020-06-18 21:32:38.917732Z",
"expired": "false",
"user_id": "user-id",
"resource_id": "connection:804252963366242252",
"sip_password": "a92dbcfb60184a8cb330b0acb2f7617b",
"sip_username": "gencrednCvHU5IYpSBPPsXI2iQsDX",
"created_at": "2020-06-18T21:32:38",
"expires_at": "2042-06-18T21:32:38",
"updated_at": "2020-06-18T21:32:38.000Z"
}
}