Skip to main content
API docs by Redocly

IO River API

Download OpenAPI specification:Download

support: support@ioriver.io License: IO River © All Rights Reserved 2022 — 2023 Terms of Service

IO River REST API Reference

Account Providers

Get all account providers

Returns the list of account providers of an account.

Authorizations:
API Key: IORiver authentication

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new account provider

Adds a new account provider to an account.

Authorizations:
API Key: IORiver authentication
Request Body schema: application/json
required
commitment_gb_per_month
number or null <double> >= 0
display_name
string
enable_commitment
boolean
is_builtin
boolean
provider
required
integer

Responses

Request samples

Content type
application/json
{
  • "commitment_gb_per_month": 0.1,
  • "display_name": "string",
  • "enable_commitment": true,
  • "is_builtin": true,
  • "provider": 0
}

Response samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "commitment_gb_per_month": 0.1,
  • "display_name": "string",
  • "enable_commitment": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_builtin": true,
  • "provider": 0,
  • "provider_details": {
    },
  • "service_uids": "string"
}

Delete an existing account provider

Removes an existing account provider from an account.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>

Responses

Retrieve an account provider

Gets a specific account provider.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "commitment_gb_per_month": 0.1,
  • "display_name": "string",
  • "enable_commitment": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_builtin": true,
  • "provider": 0,
  • "provider_details": {
    },
  • "service_uids": "string"
}

Update an existing account provider

Updates an existing account provider of an account.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
commitment_gb_per_month
number or null <double> >= 0
display_name
string
enable_commitment
boolean
is_builtin
boolean
provider
required
integer

Responses

Request samples

Content type
application/json
{
  • "commitment_gb_per_month": 0.1,
  • "display_name": "string",
  • "enable_commitment": true,
  • "is_builtin": true,
  • "provider": 0
}

Response samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "commitment_gb_per_month": 0.1,
  • "display_name": "string",
  • "enable_commitment": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_builtin": true,
  • "provider": 0,
  • "provider_details": {
    },
  • "service_uids": "string"
}

Alert Channels

Get all alert channels

Returns the list of alert channels of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new alert channel

Adds a new alert channel to a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>
Request Body schema: application/json
required
account
required
string <uuid>
channel_destination
string or null <= 512 characters
channel_type
required
string (ChannelTypeEnum)
Enum: "slack" "email" "admin"
  • slack - Slack
  • email - Email
  • admin - Admin
name
required
string <= 255 characters ^[a-zA-Z0-9_\-\s]*$

Responses

Request samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "channel_destination": "string",
  • "channel_type": "slack",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "channel_destination": "string",
  • "channel_type": "slack",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

Delete an existing alert channel

Removes an existing alert channel from a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Retrieve an alert channel

Gets a specific alert channel.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "channel_destination": "string",
  • "channel_type": "slack",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

Update an existing alert channel

Updates an existing alert channel of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>
Request Body schema: application/json
required
account
required
string <uuid>
channel_destination
string or null <= 512 characters
channel_type
required
string (ChannelTypeEnum)
Enum: "slack" "email" "admin"
  • slack - Slack
  • email - Email
  • admin - Admin
name
required
string <= 255 characters ^[a-zA-Z0-9_\-\s]*$

Responses

Request samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "channel_destination": "string",
  • "channel_type": "slack",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "channel_destination": "string",
  • "channel_type": "slack",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

Alerts

Get all alerts

Returns the list of alerts of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new alert

Adds a new alert to a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>
Request Body schema: application/json
required
account
required
string <uuid>
account_providers
Array of strings <uuid> [ items <uuid > ]
alert_type
required
string <= 255 characters
channels
required
Array of strings <uuid> [ items <uuid > ]
enabled
boolean
health_checks
Array of strings <uuid> [ items <uuid > ]
name
required
string <= 255 characters ^[a-zA-Z0-9_\-\s]*$
restrict_to_account_providers
boolean
restrict_to_health_checks
boolean
restrict_to_services
boolean
services
Array of strings <uuid> [ items <uuid > ]
threshold
integer or null [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "account_providers": [
    ],
  • "alert_type": "string",
  • "channels": [
    ],
  • "enabled": true,
  • "health_checks": [
    ],
  • "name": "string",
  • "restrict_to_account_providers": true,
  • "restrict_to_health_checks": true,
  • "restrict_to_services": true,
  • "services": [
    ],
  • "threshold": -2147483648
}

Response samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "account_providers": [
    ],
  • "alert_type": "string",
  • "channels": [
    ],
  • "enabled": true,
  • "health_checks": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "restrict_to_account_providers": true,
  • "restrict_to_health_checks": true,
  • "restrict_to_services": true,
  • "services": [
    ],
  • "threshold": -2147483648
}

Delete an existing alert

Removes an existing alert from a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Retrieve an alert

Gets a specific alert.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "account_providers": [
    ],
  • "alert_type": "string",
  • "channels": [
    ],
  • "enabled": true,
  • "health_checks": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "restrict_to_account_providers": true,
  • "restrict_to_health_checks": true,
  • "restrict_to_services": true,
  • "services": [
    ],
  • "threshold": -2147483648
}

Update an existing alert

Updates an existing alert of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>
Request Body schema: application/json
required
account
required
string <uuid>
account_providers
Array of strings <uuid> [ items <uuid > ]
alert_type
required
string <= 255 characters
channels
required
Array of strings <uuid> [ items <uuid > ]
enabled
boolean
health_checks
Array of strings <uuid> [ items <uuid > ]
name
required
string <= 255 characters ^[a-zA-Z0-9_\-\s]*$
restrict_to_account_providers
boolean
restrict_to_health_checks
boolean
restrict_to_services
boolean
services
Array of strings <uuid> [ items <uuid > ]
threshold
integer or null [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "account_providers": [
    ],
  • "alert_type": "string",
  • "channels": [
    ],
  • "enabled": true,
  • "health_checks": [
    ],
  • "name": "string",
  • "restrict_to_account_providers": true,
  • "restrict_to_health_checks": true,
  • "restrict_to_services": true,
  • "services": [
    ],
  • "threshold": -2147483648
}

Response samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "account_providers": [
    ],
  • "alert_type": "string",
  • "channels": [
    ],
  • "enabled": true,
  • "health_checks": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "restrict_to_account_providers": true,
  • "restrict_to_health_checks": true,
  • "restrict_to_services": true,
  • "services": [
    ],
  • "threshold": -2147483648
}

Test alert sending

Test alert sending

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string

Responses

Certificates

Get all certificates

Returns the list of certificates of an account.

Authorizations:
API Key: IORiver authentication

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new certificate

Adds a new certificate to an account.

Authorizations:
API Key: IORiver authentication
Request Body schema: application/json
required
cn
string <= 8192 characters
name
required
string <= 255 characters
not_valid_after
string or null <date-time>
Array of objects (ProviderCertificate)
type
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "cn": "string",
  • "name": "string",
  • "not_valid_after": "2019-08-24T14:15:22Z",
  • "providers_certificates": [
    ],
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "challenges": "string",
  • "cn": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "not_valid_after": "2019-08-24T14:15:22Z",
  • "providers_certificates": [
    ],
  • "status": "string",
  • "type": "string"
}

Delete an existing certificate

Removes an existing certificate from an account.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>

Responses

Retrieve a certificate

Gets a specific certificate.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "challenges": "string",
  • "cn": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "not_valid_after": "2019-08-24T14:15:22Z",
  • "providers_certificates": [
    ],
  • "status": "string",
  • "type": "string"
}

Update an existing certificate

Updates an existing certificate of an account.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
cn
string <= 8192 characters
name
required
string <= 255 characters
not_valid_after
string or null <date-time>
Array of objects (ProviderCertificate)
type
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "cn": "string",
  • "name": "string",
  • "not_valid_after": "2019-08-24T14:15:22Z",
  • "providers_certificates": [
    ],
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "challenges": "string",
  • "cn": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "not_valid_after": "2019-08-24T14:15:22Z",
  • "providers_certificates": [
    ],
  • "status": "string",
  • "type": "string"
}

Purge

get_all_purges

Authorizations:
API Key: IORiver Authentication
path Parameters
service_id
required
string <uuid>

IORiver service ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Purge by paths/patterns

Purge by paths/patterns

Authorizations:
API Key: IORiver Authentication
path Parameters
service_id
required
string
Request Body schema: application/json
required
patterns
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "patterns": [
    ]
}

Purge all

Purge all

Authorizations:
API Key: IORiver Authentication
path Parameters
service_id
required
string <uuid>

IORiver service ID

Responses

Services

Get all services

Returns the list of services of an account.

Authorizations:
API Key: IORiver authentication

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new service

Adds a new service to an account.

Authorizations:
API Key: IORiver authentication
Request Body schema: application/json
required
certificate
string <uuid>
description
string or null <= 255 characters

Some useful description

enable_extended_statistics
boolean
name
required
string <= 255 characters ^[a-zA-Z0-9_\-\s]*$

A service name.

(ServiceTemplateEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))

Responses

Request samples

Content type
application/json
{
  • "certificate": "b7dc5fd8-9c23-4dd8-a5cb-7431da1854eb",
  • "description": "string",
  • "enable_extended_statistics": true,
  • "name": "string",
  • "service_template": "DEFAULT"
}

Response samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "certificate": "b7dc5fd8-9c23-4dd8-a5cb-7431da1854eb",
  • "cname": "string",
  • "description": "string",
  • "enable_extended_statistics": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "read_only": true,
  • "service_template": "DEFAULT",
  • "service_uid": "string"
}

Delete an existing service

Removes an existing service from an account.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>

Responses

Retrieve a service

Gets a specific service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "certificate": "b7dc5fd8-9c23-4dd8-a5cb-7431da1854eb",
  • "cname": "string",
  • "description": "string",
  • "enable_extended_statistics": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "read_only": true,
  • "service_template": "DEFAULT",
  • "service_uid": "string"
}

Update an existing service

Updates an existing service of an account.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
Request Body schema: application/json
description
string or null <= 255 characters

Some useful description

Responses

Request samples

Content type
application/json
{
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "certificate": "b7dc5fd8-9c23-4dd8-a5cb-7431da1854eb",
  • "cname": "string",
  • "description": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "read_only": true,
  • "service_uid": "string"
}

Enable/Disable extended statistics

Enable/Disable extended statistics

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string
Request Body schema: application/json
enable
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "enable": true
}

Provider Exists

Check if given CDN provider already has a service matching given domain

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string
query Parameters
account_provider_id
required
string <uuid>

Account provider ID

Responses

Response samples

Content type
application/json
{
  • "exists": true,
  • "service_name": "string"
}

Behaviors

Get all behaviors

Returns the list of behaviors of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new behavior

Adds a new behavior to a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>
Request Body schema: application/json
required
required
Array of objects (BehaviorAction)
is_default
boolean
is_partially_contained
boolean
name
required
string <= 255 characters ^[a-zA-Z0-9_\-\s]*$
path_pattern
required
string <= 1024 characters
service
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "behavior_actions": [
    ],
  • "is_default": true,
  • "is_partially_contained": true,
  • "name": "string",
  • "path_pattern": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Response samples

Content type
application/json
{
  • "behavior_actions": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_default": true,
  • "is_partially_contained": true,
  • "name": "string",
  • "path_pattern": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Reset default behavior

Reset default behavior

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string

Responses

Response samples

Content type
application/json
{
  • "behavior_actions": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_default": true,
  • "is_partially_contained": true,
  • "name": "string",
  • "path_pattern": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Delete an existing behavior

Removes an existing behavior from a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Retrieve a behavior

Gets a specific behavior.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "behavior_actions": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_default": true,
  • "is_partially_contained": true,
  • "name": "string",
  • "path_pattern": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Update an existing behavior

Updates an existing behavior of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>
Request Body schema: application/json
required
required
Array of objects (BehaviorAction)
is_default
boolean
is_partially_contained
boolean
name
required
string <= 255 characters ^[a-zA-Z0-9_\-\s]*$
path_pattern
required
string <= 1024 characters
service
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "behavior_actions": [
    ],
  • "is_default": true,
  • "is_partially_contained": true,
  • "name": "string",
  • "path_pattern": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Response samples

Content type
application/json
{
  • "behavior_actions": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_default": true,
  • "is_partially_contained": true,
  • "name": "string",
  • "path_pattern": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Computes

Get all compute functions

Returns the list of compute functions of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new compute function

Adds a new compute function to a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>
Request Body schema: application/json
required
required
Array of objects (ComputeRoute)
name
required
string <= 255 characters ^(?=[a-zA-Z_])(?=\S)([a-zA-Z]|[a-zA-Z][a-zA-Z...
request_code
string or null <= 1048576 characters
response_code
string or null <= 1048576 characters
service
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "compute_routes": [
    ],
  • "name": "string",
  • "request_code": "string",
  • "response_code": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Response samples

Content type
application/json
{
  • "compute_routes": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "request_code": "string",
  • "response_code": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Delete an existing compute function

Removes an existing compute function from a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Retrieve a compute function

Gets a specific compute function.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "compute_routes": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "request_code": "string",
  • "response_code": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Update an existing compute function

Updates an existing compute function of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>
Request Body schema: application/json
required
required
Array of objects (ComputeRoute)
name
required
string <= 255 characters ^(?=[a-zA-Z_])(?=\S)([a-zA-Z]|[a-zA-Z][a-zA-Z...
request_code
string or null <= 1048576 characters
response_code
string or null <= 1048576 characters
service
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "compute_routes": [
    ],
  • "name": "string",
  • "request_code": "string",
  • "response_code": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Response samples

Content type
application/json
{
  • "compute_routes": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "request_code": "string",
  • "response_code": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Domain Mappings

Get all domain mappings

Returns the list of domain mappings of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new domain mapping

Adds a new domain mapping to a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>
Request Body schema: application/json
required
domain
required
string <= 255 characters
is_partially_contained
boolean
load_balancer
string or null <uuid>
origin
string or null <uuid>
path_pattern
string or null <= 1024 characters
service
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "domain": "string",
  • "is_partially_contained": true,
  • "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
  • "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
  • "path_pattern": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Response samples

Content type
application/json
{
  • "domain": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_partially_contained": true,
  • "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
  • "load_balancer_object": "string",
  • "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
  • "origin_object": "string",
  • "path_pattern": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Delete an existing domain mapping

Removes an existing domain mapping from a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Retrieve a domain mapping

Gets a specific domain mapping.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "domain": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_partially_contained": true,
  • "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
  • "load_balancer_object": "string",
  • "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
  • "origin_object": "string",
  • "path_pattern": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Update an existing domain mapping

Updates an existing domain mapping of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>
Request Body schema: application/json
required
domain
required
string <= 255 characters
is_partially_contained
boolean
load_balancer
string or null <uuid>
origin
string or null <uuid>
path_pattern
string or null <= 1024 characters
service
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "domain": "string",
  • "is_partially_contained": true,
  • "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
  • "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
  • "path_pattern": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Response samples

Content type
application/json
{
  • "domain": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_partially_contained": true,
  • "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
  • "load_balancer_object": "string",
  • "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
  • "origin_object": "string",
  • "path_pattern": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Geo Restrictions

Get all geo restrictions

Returns the list of geo restrictions of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new geo restriction

Adds a new geo restriction to a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>
Request Body schema: application/json
required
required
Array of objects (GeoRestrictionCountry)
service
required
string <uuid>
type
required
string (GeoRestrictionTypeEnum)
Enum: "allow" "deny"
  • allow - Allow
  • deny - Deny

Responses

Request samples

Content type
application/json
{
  • "countries": [
    ],
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "type": "allow"
}

Response samples

Content type
application/json
{
  • "countries": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "type": "allow"
}

Delete an existing geo restriction

Removes an existing geo restriction from a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Retrieve a geo restriction

Gets a specific geo restriction.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "countries": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "type": "allow"
}

Update an existing geo restriction

Updates an existing geo restriction of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>
Request Body schema: application/json
required
required
Array of objects (GeoRestrictionCountry)
service
required
string <uuid>
type
required
string (GeoRestrictionTypeEnum)
Enum: "allow" "deny"
  • allow - Allow
  • deny - Deny

Responses

Request samples

Content type
application/json
{
  • "countries": [
    ],
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "type": "allow"
}

Response samples

Content type
application/json
{
  • "countries": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "type": "allow"
}

Health Checks

Get all health-checks

Returns the list of health-checks of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new health-check

Adds a new health-check to a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>
Request Body schema: application/json
required
enabled
boolean
name
required
string <= 255 characters ^[a-zA-Z0-9_\-\s]*$
service
required
string <uuid>
url
required
string <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "name": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "url": "string"
}

Delete an existing health-check

Removes an existing health-check from a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Retrieve a health-check

Gets a specific health-check.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "url": "string"
}

Update an existing health-check

Updates an existing health-check of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>
Request Body schema: application/json
required
enabled
boolean
name
required
string <= 255 characters ^[a-zA-Z0-9_\-\s]*$
service
required
string <uuid>
url
required
string <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "name": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "url": "string"
}

Load Balancers

Get all load-balancers

Returns the list of load-balancers of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new load-balancer

Adds a new load-balancer to a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>
Request Body schema: application/json
required
name
required
string <= 255 characters ^[a-zA-Z0-9_\-\s]*$
required
Array of objects (LoadBalancerOriginSet)
service
required
string <uuid>
type
required
string (LoadBalancerTypeEnum)
Value: "weighted"
  • weighted - Weighted

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "origin_sets": [
    ],
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "type": "weighted"
}

Response samples

Content type
application/json
{
  • "custom_rules": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "origin_sets": [
    ],
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "type": "weighted"
}

Delete an existing load-balancer

Removes an existing load-balancer from a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Retrieve a load-balancer

Gets a specific load-balancer.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "custom_rules": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "origin_sets": [
    ],
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "type": "weighted"
}

Update an existing load-balancer

Updates an existing load-balancer of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>
Request Body schema: application/json
required
name
required
string <= 255 characters ^[a-zA-Z0-9_\-\s]*$
required
Array of objects (LoadBalancerOriginSet)
service
required
string <uuid>
type
required
string (LoadBalancerTypeEnum)
Value: "weighted"
  • weighted - Weighted

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "origin_sets": [
    ],
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "type": "weighted"
}

Response samples

Content type
application/json
{
  • "custom_rules": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "origin_sets": [
    ],
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "type": "weighted"
}

Load Balancer Custom Rules

Get all load-balancer custom rules

Returns the list of load-balancer custom rules of a load-balancer.

Authorizations:
API Key: IORiver authentication
path Parameters
load_balancer_id
required
string
service_id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new load-balancer custom rule

Adds a new load-balancer custom rule to a load-balancer.

Authorizations:
API Key: IORiver authentication
path Parameters
load_balancer_id
required
string
service_id
required
string
Request Body schema: application/json
required
load_balancer
required
string <uuid>
matching_rule
required
any
name
required
string <= 255 characters ^[a-zA-Z0-9_\-\s]*$
origin_set
required
string <uuid>
priority
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]

Responses

Request samples

Content type
application/json
{
  • "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
  • "matching_rule": null,
  • "name": "string",
  • "origin_set": "ef7a9ba9-aa71-439d-ba74-768e986e8c01",
  • "priority": -9223372036854776000
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
  • "matching_rule": null,
  • "name": "string",
  • "origin_set": "ef7a9ba9-aa71-439d-ba74-768e986e8c01",
  • "origin_set_name": "string",
  • "priority": -9223372036854776000
}

Delete an existing load-balancer custom rule

Removes an existing load-balancer custom rule from a load-balancer.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
load_balancer_id
required
string
service_id
required
string

Responses

Retrieve a load-balancer custom rule

Gets a specific load-balancer custom rule.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
load_balancer_id
required
string
service_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
  • "matching_rule": null,
  • "name": "string",
  • "origin_set": "ef7a9ba9-aa71-439d-ba74-768e986e8c01",
  • "origin_set_name": "string",
  • "priority": -9223372036854776000
}

Update an existing load-balancer custom rule

Updates an existing load-balancer custom rule of a load-balancer.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
load_balancer_id
required
string
service_id
required
string
Request Body schema: application/json
required
load_balancer
required
string <uuid>
matching_rule
required
any
name
required
string <= 255 characters ^[a-zA-Z0-9_\-\s]*$
origin_set
required
string <uuid>
priority
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]

Responses

Request samples

Content type
application/json
{
  • "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
  • "matching_rule": null,
  • "name": "string",
  • "origin_set": "ef7a9ba9-aa71-439d-ba74-768e986e8c01",
  • "priority": -9223372036854776000
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
  • "matching_rule": null,
  • "name": "string",
  • "origin_set": "ef7a9ba9-aa71-439d-ba74-768e986e8c01",
  • "origin_set_name": "string",
  • "priority": -9223372036854776000
}

Logs Destinations

Get all loggings

Returns the list of loggings of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new logging

Adds a new logging to a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>
Request Body schema: application/json
required
credentials
string
name
string
s3_bucket
required
string
s3_domain
string <= 1024 characters
s3_path
string <= 1024 characters
s3_region
string <= 1024 characters
service
required
string <uuid>
type
string (UnifiedLogDestinationTypeEnum)
Enum: "S3" "S3_COMPATIBLE"
  • S3 - S3
  • S3_COMPATIBLE - S3 Compatible

Responses

Request samples

Content type
application/json
{
  • "credentials": "string",
  • "name": "string",
  • "s3_bucket": "string",
  • "s3_domain": "string",
  • "s3_path": "string",
  • "s3_region": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "type": "S3"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "s3_bucket": "string",
  • "s3_domain": "string",
  • "s3_path": "string",
  • "s3_region": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "type": "S3"
}

Delete an existing logging

Removes an existing logging from a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Retrieve a logging

Gets a specific logging.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "s3_bucket": "string",
  • "s3_domain": "string",
  • "s3_path": "string",
  • "s3_region": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "type": "S3"
}

Update an existing logging

Updates an existing logging of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>
Request Body schema: application/json
required
credentials
string
name
string
s3_bucket
required
string
s3_domain
string <= 1024 characters
s3_path
string <= 1024 characters
s3_region
string <= 1024 characters
service
required
string <uuid>
type
string (UnifiedLogDestinationTypeEnum)
Enum: "S3" "S3_COMPATIBLE"
  • S3 - S3
  • S3_COMPATIBLE - S3 Compatible

Responses

Request samples

Content type
application/json
{
  • "credentials": "string",
  • "name": "string",
  • "s3_bucket": "string",
  • "s3_domain": "string",
  • "s3_path": "string",
  • "s3_region": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "type": "S3"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "s3_bucket": "string",
  • "s3_domain": "string",
  • "s3_path": "string",
  • "s3_region": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "type": "S3"
}

Origin Sets

Get all origin-sets

Returns the list of origin-sets of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new origin-set

Adds a new origin-set to a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>
Request Body schema: application/json
required
name
required
string <= 255 characters ^[a-zA-Z0-9_\-\s]*$
required
Array of objects (OriginSetMember)
service
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "origins": [
    ],
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "origins": [
    ],
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Delete an existing origin-set

Removes an existing origin-set from a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Retrieve an origin-set

Gets a specific origin-set.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "origins": [
    ],
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Update an existing origin-set

Updates an existing origin-set of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>
Request Body schema: application/json
required
name
required
string <= 255 characters ^[a-zA-Z0-9_\-\s]*$
required
Array of objects (OriginSetMember)
service
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "origins": [
    ],
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "origins": [
    ],
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Origins

Get all origins

Returns the list of origins of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new origin

Adds a new origin to a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>
Request Body schema: application/json
required
host
required
string <= 255 characters (^(?=.{1,253}\.)[a-zA-Z0-9_-]+(\.[a-zA-Z0-9_-...
is_private_s3
boolean
is_s3
boolean
path
string
port
required
integer [ 0 .. 65535 ]
protocol
string (ProtocolEnum)
Enum: "HTTP" "HTTPS" "HTTP & HTTPS"
  • HTTP - Http
  • HTTPS - Https
  • HTTP & HTTPS - Both
s3_aws_region
string or null
s3_bucket_name
string or null
service
required
string <uuid>
object or null
shield_location
any or null
Array of objects (OriginShieldProvider)
timeout_ms
integer or null [ -2147483648 .. 2147483647 ]
type
string (OriginTypeEnum)
Enum: "CUSTOM" "SERVICE_PROVIDER"
  • CUSTOM - Custom
  • SERVICE_PROVIDER - Service Provider

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "is_private_s3": true,
  • "is_s3": true,
  • "path": "string",
  • "port": 65535,
  • "protocol": "HTTP",
  • "s3_aws_region": "string",
  • "s3_bucket_name": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "service_provider": {
    },
  • "shield_location": null,
  • "shield_providers": [
    ],
  • "timeout_ms": -2147483648,
  • "type": "CUSTOM"
}

Response samples

Content type
application/json
{
  • "host": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_private_s3": true,
  • "is_s3": true,
  • "path": "string",
  • "port": 65535,
  • "protocol": "HTTP",
  • "s3_aws_region": "string",
  • "s3_bucket_name": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "service_provider": {
    },
  • "shield_location": null,
  • "shield_providers": [
    ],
  • "timeout_ms": -2147483648,
  • "type": "CUSTOM"
}

Delete an existing origin

Removes an existing origin from a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Retrieve an origin

Gets a specific origin.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "host": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_private_s3": true,
  • "is_s3": true,
  • "path": "string",
  • "port": 65535,
  • "protocol": "HTTP",
  • "s3_aws_region": "string",
  • "s3_bucket_name": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "service_provider": {
    },
  • "shield_location": null,
  • "shield_providers": [
    ],
  • "timeout_ms": -2147483648,
  • "type": "CUSTOM"
}

Update an existing origin

Updates an existing origin of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>
Request Body schema: application/json
required
host
required
string <= 255 characters (^(?=.{1,253}\.)[a-zA-Z0-9_-]+(\.[a-zA-Z0-9_-...
is_private_s3
boolean
is_s3
boolean
path
string
port
required
integer [ 0 .. 65535 ]
protocol
string (ProtocolEnum)
Enum: "HTTP" "HTTPS" "HTTP & HTTPS"
  • HTTP - Http
  • HTTPS - Https
  • HTTP & HTTPS - Both
s3_aws_region
string or null
s3_bucket_name
string or null
service
required
string <uuid>
object or null
shield_location
any or null
Array of objects (OriginShieldProvider)
timeout_ms
integer or null [ -2147483648 .. 2147483647 ]
type
string (OriginTypeEnum)
Enum: "CUSTOM" "SERVICE_PROVIDER"
  • CUSTOM - Custom
  • SERVICE_PROVIDER - Service Provider

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "is_private_s3": true,
  • "is_s3": true,
  • "path": "string",
  • "port": 65535,
  • "protocol": "HTTP",
  • "s3_aws_region": "string",
  • "s3_bucket_name": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "service_provider": {
    },
  • "shield_location": null,
  • "shield_providers": [
    ],
  • "timeout_ms": -2147483648,
  • "type": "CUSTOM"
}

Response samples

Content type
application/json
{
  • "host": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_private_s3": true,
  • "is_s3": true,
  • "path": "string",
  • "port": 65535,
  • "protocol": "HTTP",
  • "s3_aws_region": "string",
  • "s3_bucket_name": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "service_provider": {
    },
  • "shield_location": null,
  • "shield_providers": [
    ],
  • "timeout_ms": -2147483648,
  • "type": "CUSTOM"
}

Performance Checks

Get all performance-checks

Returns the list of performance-checks of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new performance-check

Adds a new performance-check to a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>
Request Body schema: application/json
required
enabled
boolean
name
required
string <= 255 characters ^[a-zA-Z0-9_\-\s]*$
service
required
string <uuid>
url
required
string <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "name": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "url": "string"
}

Delete an existing performance-check

Removes an existing performance-check from a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Retrieve a performance-check

Gets a specific performance-check.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "url": "string"
}

Update an existing performance-check

Updates an existing performance-check of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>
Request Body schema: application/json
required
enabled
boolean
name
required
string <= 255 characters ^[a-zA-Z0-9_\-\s]*$
service
required
string <uuid>
url
required
string <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "name": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "url": "string"
}

Protocol Configs

Get all protocol configs

Returns the list of protocol configs of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new protocol config

Adds a new protocol config to a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>
Request Body schema: application/json
required
http2_enabled
boolean

Allow HTTP/2

http3_enabled
boolean

Allow HTTP/3

ipv6_enabled
boolean

Enable IPv6

service
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "http2_enabled": true,
  • "http3_enabled": true,
  • "ipv6_enabled": true,
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Response samples

Content type
application/json
{
  • "http2_enabled": true,
  • "http3_enabled": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ipv6_enabled": true,
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Delete an existing protocol config

Removes an existing protocol config from a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Retrieve a protocol config

Gets a specific protocol config.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "http2_enabled": true,
  • "http3_enabled": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ipv6_enabled": true,
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Update an existing protocol config

Updates an existing protocol config of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>
Request Body schema: application/json
required
http2_enabled
boolean

Allow HTTP/2

http3_enabled
boolean

Allow HTTP/3

ipv6_enabled
boolean

Enable IPv6

service
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "http2_enabled": true,
  • "http3_enabled": true,
  • "ipv6_enabled": true,
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Response samples

Content type
application/json
{
  • "http2_enabled": true,
  • "http3_enabled": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ipv6_enabled": true,
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Service Providers

Get all service-providers

Returns the list of service-providers of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new service-provider

Adds a new service-provider to a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>
Request Body schema: application/json
required
account_provider
string <uuid>
akamai_amd_stream
string or null
cname
string or null <= 255 characters
display_name
string or null <= 255 characters
is_unmanaged
boolean
Default: false
service
required
string <uuid>
use_akamai_media_services
boolean

Responses

Request samples

Content type
application/json
{
  • "account_provider": "47bf4c54-d188-4d3d-9806-5f87b0246c21",
  • "akamai_amd_stream": "string",
  • "cname": "string",
  • "display_name": "string",
  • "is_unmanaged": false,
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "use_akamai_media_services": true
}

Response samples

Content type
application/json
{
  • "account_provider": "47bf4c54-d188-4d3d-9806-5f87b0246c21",
  • "akamai_amd_stream": "string",
  • "cname": "string",
  • "display_name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "restored": true,
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "status": "string",
  • "status_details": "string",
  • "use_akamai_media_services": true
}

Delete an existing service-provider

Removes an existing service-provider from a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Retrieve a service-provider

Gets a specific service-provider.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "account_provider": "47bf4c54-d188-4d3d-9806-5f87b0246c21",
  • "akamai_amd_stream": "string",
  • "cname": "string",
  • "display_name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "restored": true,
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "status": "string",
  • "status_details": "string",
  • "use_akamai_media_services": true
}

Update an existing service-provider

Updates an existing service-provider of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>
Request Body schema: application/json
required
account_provider
string <uuid>
akamai_amd_stream
string or null
cname
string or null <= 255 characters
display_name
string or null <= 255 characters
is_unmanaged
boolean
Default: false
service
required
string <uuid>
use_akamai_media_services
boolean

Responses

Request samples

Content type
application/json
{
  • "account_provider": "47bf4c54-d188-4d3d-9806-5f87b0246c21",
  • "akamai_amd_stream": "string",
  • "cname": "string",
  • "display_name": "string",
  • "is_unmanaged": false,
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "use_akamai_media_services": true
}

Response samples

Content type
application/json
{
  • "account_provider": "47bf4c54-d188-4d3d-9806-5f87b0246c21",
  • "akamai_amd_stream": "string",
  • "cname": "string",
  • "display_name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "restored": true,
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "status": "string",
  • "status_details": "string",
  • "use_akamai_media_services": true
}

Request Logs

Get all request-loggings

Returns the list of request-loggings of a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new request-logging

Adds a new request-logging to a service.

Authorizations:
API Key: IORiver authentication
path Parameters
service_id
required
string <uuid>
Request Body schema: application/json
required
bucket_name
required
string <= 1024 characters
credentials
required
string <= 4096 characters
domain
string <= 1024 characters
name
required
string <= 255 characters ^[a-zA-Z0-9_\-\s]*$
path
string <= 1024 characters
service
required
string <uuid>
type
required
string (Type565Enum)
Value: "AWS_S3"
  • AWS_S3 - Aws S3

Responses

Request samples

Content type
application/json
{
  • "bucket_name": "string",
  • "credentials": "string",
  • "domain": "string",
  • "name": "string",
  • "path": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "type": "AWS_S3"
}

Response samples

Content type
application/json
{
  • "bucket_name": "string",
  • "domain": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "path": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "type": "AWS_S3"
}

Delete an existing request-logging

Removes an existing request-logging from a service.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses

Retrieve a request-logging

Gets a specific request-logging.

Authorizations:
API Key: IORiver authentication
path Parameters
id
required
string <uuid>
service_id
required
string <uuid>

Responses