Prerequisite: You need administrative privileges to create and assign user privileges by using the Cloud API.
To set user privileges using the Cloud API for managing Cloud CDN distribution, follow these steps:
Authenticate to the Cloud API using your API credentials.
Create a user using the POST /cloudapi/v6/um/users
endpoint.
Set the following required parameters for the user: user's name
, email address
, and password
.
Create a group using the POST /cloudapi/v6/um/groups
endpoint.
Set accessAndManageCdn
privilege to true
.
Assign the user to the created group using POST /cloudapi/v6/um/groups/{groupId}/users
endpoint and provide the user ID in the header.
Note: The user ID in the request body could be as, id: <userID>
.
Result: The accessAndManageCdn
privilege is granted to the user.
Prerequisite: Only contract administrators, owners, and users with accessAndManageCdn
privilege can create and manage CDN distributions via the API. You can also set user privileges in the DCD. For more information, see Set User Privileges.
To retrieve all the CDN distributions under a contract, perform a GET
request.
Use the following endpoint to retrieve all CDN distributions for a contract: https://cdn.de-fra.ionos.com/distributions
.
To make authenticated requests to the API, the following fields are mandatory in the request header:
Authorization
yes
string
Content-Type
yes
string
Set this to application/json
.
200 Successful operation
Result: All the existing CDN distributions and their details are successfully obtained for your contract.
Prerequisite: Only contract administrators, owners, and users with accessAndManageCdn
privilege can create and manage CDN distributions via the API. You can also set user privileges in the DCD. For more information, see Set User Privileges.
To retrieve a CDN distribution, perform a GET
request with the distributionId
of the CDN.
Use the following endpoint to retrieve a CDN distribution: https://cdn.de-fra.ionos.com/distributions/{distributionId}
.
Note: The following request contains a sample distributionId
. Replace them with the distributionId
value, whose information you want to retrieve.
Below is the list of mandatory path parameter:
distributionId
string
The ID (UUID) of the CDN distribution.
9ba15778-16c4-543c-8775-e52acf4853f5
To make authenticated requests to the API, the following fields are mandatory in the request header:
Authorization
yes
string
Content-Type
yes
string
Set this to application/json
.
200 Successful operation
Result: The CDN distribution details are retrieved for the given distributionId
.
Prerequisite: Only contract administrators, owners, and users with accessAndManageCdn
privilege can create and manage CDN distributions via the API. You can also set user privileges in the DCD. For more information, see Set User Privileges.
To update an existing CDN distribution, perform a PUT
request with the distributionID
of the CDN. The CDN distribution for a given distributionID
is updated with the provided distribution details.
Note: If a CDN distribution for a given distributionID
does not exist, a distribution is created instead.
Use the following endpoint to create or update a CDN distribution: https://cdn.de-fra.ionos.com/distributions/{distributionId}
.
Note: The following request contains a sample distributionId
. Replace them with the distributionId
value whose information you want to update.
Below is the list of mandatory path parameter:
distributionId
string
The ID (UUID) of the CDN distribution.
9ba15778-16c4-543c-8775-e52acf4853f5
Below is the list of mandatory body parameters:
id
string
The ID (UUID) of the CDN distribution.
9ba15778-16c4-543c-8775-e52acf4853f5
domain
string
The domain name for the CDN distribution.
example.com
scheme
string
Choose whether to allow http
, https
, or http/https
protocol.
http/https
prefix
string
A prefix to match the beginning segment of the URL path and apply routing rule.
/api
host
string
An upstream host name that handles requests if data not cached in the CDN edge server.
server.example.com
caching
boolean
If enabled, CDN caches the data from the upstream host.
true
waf
boolean
If enabled, protects the upstream host.
true
rateLimitClass
string
Limits the number of incoming requests per IP.
R10
To make authenticated requests to the API, the following fields are mandatory in the request header:
Authorization
yes
string
Content-Type
yes
string
Set this to application/json
.
200 Successful operation
Following is an example of when a CDN distribution is successfully created.
Result: A CDN distribution is successfully updated or created.
With CDN APIs, contract administrators, owners, and users with the required permissions can create and manage CDN distributions.
Set required user privileges for a user to create and manage CDN distributions.
Create a CDN distribution.
Using the distribution ID, get all the details of a CDN distribution.
Get all the requested CDN distributions details.
A distribution updated for the provided distribution ID. If already a distribution does not exist for the given distribution ID, a new one is created.
Deletes the specified CDN distribution.
Prerequisite: Only contract administrators, owners, and users with accessAndManageCdn
privilege can create and manage CDN distributions via the API. You can also set user privileges in the DCD. For more information, see .
To delete a CDN distribution, perform a DELETE
request with the distributionID
of the CDN.
Use the following endpoint to delete a CDN distribution: https://cdn.de-fra.ionos.com/distributions/{distributionId}
.
Note: The following request contains a sample distributionId
. Replace them with the distributionId
value, whose information you want to retrieve.
Below is the list of mandatory path parameter:
To make authenticated requests to the API, the following fields are mandatory in the request header:
202 Successful operation
Result: The CDN distribution for the specified distributionID
is successfully deleted.
Prerequisite: Only contract administrators, owners, and users with accessAndManageCdn
privilege can create and manage CDN distributions via the API. You can also set user privileges in the DCD. For more information, see .
To create a CDN distribution, perform a POST
request.
Use the following endpoint to create a CDN distribution: https://cdn.de-fra.ionos.com/distributions
.
Below is the list of mandatory body parameters:
To make authenticated requests to the API, the following fields are mandatory in the request header:
201 Successful operation
Result: The CDN distribution is successfully created; the id
and other details of the created distribution are provided in the response.
The Bearer token enables requests to authenticate using a JSON Web Token (JWT). From the DCD, .
The Bearer token enables requests to authenticate using a JSON Web Token (JWT). From the DCD, .
The Bearer token enables requests to authenticate using a JSON Web Token (JWT). From the DCD, .
domain
string
The domain name for the CDN distribution.
example.com
scheme
string
Choose whether to allow http
, https
, or http/https
protocol.
http/https
prefix
string
A prefix to match the beginning segment of the URL path and apply routing rule.
/api
host
string
An upstream host name that handles requests if data not cached in the CDN edge server.
server.example.com
caching
boolean
If enabled, CDN caches the data from the upstream host.
true
waf
boolean
If enabled, protects the upstream host.
true
rateLimitClass
string
Limits the number of incoming requests per IP.
R10
distributionId
string
The ID (UUID) of the CDN distribution.
9ba15778-16c4-543c-8775-e52acf4853f5
Authorization
yes
string
Content-Type
yes
string
Set this to application/json
.
Authorization
yes
string
Content-Type
yes
string
Set this to application/json
.
The Bearer token enables requests to authenticate using a JSON Web Token (JWT). From the DCD, .
The Bearer token enables requests to authenticate using a JSON Web Token (JWT). From the DCD, .