Resources

Create, view, update, and delete CDN resources. Use these endpoints to provision a CDN resource, configure its source (CDN Storage or origin), and manage its lifecycle.

Get CDN resource details

get

Retrieve configuration and status details for a specific CDN resource within an organization.

Authorizations
AuthorizationstringRequired

Send the access token as a Bearer token in the Authorization header.

Path parameters
organization_uuidstring · uuidRequired

The organization UUID.

Example: 2f6c4f3a-2c48-4c2b-8e13-7d7c0f4e9b2a
resource_uuidstring · uuidRequired

The resource UUID.

Example: 8c3a1a2e-1a5a-4a4a-9d2f-3b2f9a5b9c11
Responses
chevron-right
200

Resource details retrieved successfully.

application/json
get
/api/v1/cdn/{organization_uuid}/resource/{resource_uuid}

Create a CDN Storage resource

post

Create a CDN resource that uses CDN Storage as its origin. Select the resource type (small or large) and provide the storage path configuration.

Authorizations
AuthorizationstringRequired

Send the access token as a Bearer token in the Authorization header.

Path parameters
organization_uuidstring · uuidRequired

The organization UUID.

Example: 123e4567-e89b-12d3-a456-426614174000
Body
resource_namestringRequired

Resource name. This value is used when generating the default CDN hostname.

Example: small-storage
resource_labelstringOptional

Optional label for the resource.

Example: labelstorage
data_sourcestringRequired

Data source for the resource. Use storage for CDN Storage-backed resources.

Example: storage
resource_typestring · enumRequired

Resource type/plan.

Example: smallPossible values:
storage_versionstringRequired

Storage API version associated with the storage path configuration.

Example: v2
storage_path_uuidstring · uuidRequired

UUID of the storage path.

Example: 8c3a1a2e-1a5a-4a4a-9d2f-3b2f9a5b9c11
storage_path_directorystringRequired

Directory name under the storage path.

Example: test
Responses
chevron-right
200

Resource created successfully.

application/json
post
/api/v1/cdn/{organization_uuid}/resource
200

Resource created successfully.

Create a dynamic CDN resource

post

Create a CDN resource that pulls content from one or more origin servers. Provide origin settings (protocol, ports, host header, and priority) to configure how the CDN connects to your origin.

Authorizations
AuthorizationstringRequired

Send the access token as a Bearer token in the Authorization header.

Path parameters
organization_uuidstring · uuidRequired

The organization UUID.

Example: 123e4567-e89b-12d3-a456-426614174000
Body
resource_namestringRequired

Resource name. This value is used when generating the default CDN hostname.

resource_labelstring · nullableOptional

Optional label for the resource.

data_sourcestring · enumRequired

Data source for the resource.

Possible values:
resource_typestring · enumRequired

Resource type.

Possible values:
origin_typestring · enumRequired

Origin type.

Possible values:
server_namestringRequired

Primary domain/hostname associated with this resource (used for configuration and routing).

Example: testtest.com
Responses
chevron-right
200

Resource created successfully.

application/json
post
/api/v1/cdn/{organization_uuid}/resource

Create a streaming CDN resource

post

Create a streaming resource that pulls content from an origin. Provide the origin protocol and origin hostname/URL to configure the source.

Authorizations
AuthorizationstringRequired

Send the access token as a Bearer token in the Authorization header.

Path parameters
organization_uuidstring · uuidRequired

The organization UUID.

Example: 123e4567-e89b-12d3-a456-426614174000
Body
resource_namestringRequired

Resource name. This value is used when generating the default CDN hostname.

Example: streaming-test
resource_labelstring · nullableOptional

Optional label for the resource.

data_sourcestring · enumRequired

Data source for the resource.

Example: originPossible values:
resource_typestring · enumRequired

Resource type.

Example: streamingPossible values:
protocolstring · enumRequired

Protocol used to connect to the origin.

Example: httpsPossible values:
origin_urlstringRequired

Origin hostname or URL.

Example: streaming-test.com
Responses
chevron-right
200

Resource created successfully.

application/json
post
/api/v1/cdn/{organization_uuid}/resource

Create an RTMP push streaming resource

post

Create a streaming resource for RTMP push workflows. Provide RTMP authentication credentials to protect publishing access.

Authorizations
AuthorizationstringRequired

Send the access token as a Bearer token in the Authorization header.

Path parameters
organization_uuidstring · uuidRequired

The organization UUID.

Example: 123e4567-e89b-12d3-a456-426614174000
Body
resource_namestringRequired

Resource name. This value is used when generating the default CDN hostname.

Example: test-rtmp-push
resource_labelstring · nullableOptional

Optional label for the resource.

data_sourcestring · enumRequired

Data source for the resource.

Example: rtmp_pushPossible values:
resource_typestring · enumRequired

Resource type.

Example: streamingPossible values:
auth_usernamestringRequired

Username used for RTMP publishing authentication.

Example: test
auth_passwordstring · passwordRequired

Password used for RTMP publishing authentication.

Example: 8CharPass.
Responses
chevron-right
200

Resource created successfully.

application/json
post
/api/v1/cdn/{organization_uuid}/resource

Create an FLV streaming resource

post

Create a streaming resource for FLV delivery. Provide the origin URL and streaming protocol, and configure whether the FLV media server option is enabled.

Authorizations
AuthorizationstringRequired

Send the access token as a Bearer token in the Authorization header.

Path parameters
organization_uuidstring · uuidRequired

The organization UUID.

Example: 123e4567-e89b-12d3-a456-426614174000
Body
resource_namestringRequired

Resource name. This value is used when generating the default CDN hostname.

Example: test
resource_labelstring · nullableOptional

Optional label for the resource.

data_sourcestring · enumRequired

Data source for the resource.

Example: stream_flvPossible values:
resource_typestring · enumRequired

Resource type.

Example: streamingPossible values:
protocolstring · enumRequired

Streaming protocol used for this resource.

Example: rtmpPossible values:
stream_flv_media_serverbooleanRequired

Enable or disable the FLV media server option.

Example: false
origin_urlstringRequired

Origin hostname or URL.

Example: flv.test.com
Responses
chevron-right
200

Resource created successfully.

application/json
post
/api/v1/cdn/{organization_uuid}/resource

Enable or disable a CDN resource

put

Enable or disable a specific CDN resource by updating its status.

Authorizations
AuthorizationstringRequired

Send the access token as a Bearer token in the Authorization header.

Path parameters
organization_uuidstring · uuidRequired

The organization UUID.

Example: 123e4567-e89b-12d3-a456-426614174000
resource_uuidstring · uuidRequired

The resource UUID.

Example: 8c3a1a2e-1a5a-4a4a-9d2f-3b2f9a5b9c11
Body
statusbooleanRequired

Set to true to enable the resource, or false to disable it.

Responses
chevron-right
200

Resource status updated successfully.

application/json
put
/api/v1/cdn/{organization_uuid}/resource/{resource_uuid}

Delete a CDN resource

delete

Permanently delete a specific CDN resource from an organization.

Authorizations
AuthorizationstringRequired

Send the access token as a Bearer token in the Authorization header.

Path parameters
organization_uuidstring · uuidRequired

The organization UUID.

Example: 2f6c4f3a-2c48-4c2b-8e13-7d7c0f4e9b2a
resource_uuidstring · uuidRequired

The resource UUID.

Example: 8c3a1a2e-1a5a-4a4a-9d2f-3b2f9a5b9c11
Responses
chevron-right
200

Resource deleted successfully.

application/json
delete
/api/v1/cdn/{organization_uuid}/resource/{resource_uuid}

Last updated

Was this helpful?