Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Calls TURN Keys API

The Calls TURN Keys API from APIs.io Engineering Platform — 2 operation(s) for calls turn keys.

This API exposes 5 operations across 2 paths, and defines 14 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

5 operations 2 paths 14 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Calls TURN Keys API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Calls TURN Keys 5
GET
/accounts/{account_id}/calls/turn_keys
APIs.io Engineering Platform List TURN Keys
calls-turn-key-list 1 param → 4XX200
POST
/accounts/{account_id}/calls/turn_keys
APIs.io Engineering Platform Create a new TURN key
calls-turn-key-create 1 param body → 201
DELETE
/accounts/{account_id}/calls/turn_keys/{key_id}
APIs.io Engineering Platform Delete TURN key
calls-delete-turn-key 2 params → 4XX200
GET
/accounts/{account_id}/calls/turn_keys/{key_id}
APIs.io Engineering Platform Retrieve TURN key details
calls-retrieve-turn-key-details 2 params → 4XX200
PUT
/accounts/{account_id}/calls/turn_keys/{key_id}
APIs.io Engineering Platform Edit TURN key details
calls-update-turn-key 2 params body → 4XX200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are calls_turn_key_with_key (5 properties), calls_api-response-common-failure (4 properties), calls_api-response-common (3 properties), calls_turn_key_editable_fields (1 property). Each schema is shown below with its type and property counts.

calls_api-response-common-failure
object
4 properties 4 required
calls_identifier
string
A Cloudflare-generated unique identifier for a item.
calls_api-response-single
object
calls_turn_key_name
string
A short description of a TURN key, not shown to end users.
calls_turn_key_response_single
calls_account_identifier
string
The account identifier tag.
calls_turn_key_editable_fields
object
1 property
calls_turn_key_with_key
object
5 properties
calls_created
string
The date and time the item was created.
calls_modified
string
The date and time the item was last modified.
calls_api-response-common
object
3 properties 3 required
calls_turn_key_collection
calls_turn_key
string
Bearer token
calls_messages
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-calls-turn-keys-api-openapi.yml Raw ↑