Origins
GET Origins#
Get all origins of the distribution.
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/origins |
| Headers | Authorization |
| Parameters | distributionId, projectId, version |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {distributionId} | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projctId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty project configuration is returned |
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| distributionId | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "originDomainNameAndPath": "string", "originId": "string", "originType": "string", "originProtocolPolicy": "string", "httpsPort": 0, "httpPort": 0, "originResponseTimeout": 0, "originKeepAliveTimeout": 0, "originConnectionAttempts": 0, "originConnectionTimeout": 0 } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns a behavior object | |
| originDomainNameAndPath | string | "string" | Returns the user input when creating origin, giving domain name and path |
| originId | string | "string" | Returns the origin id of the created origin |
| originType | string | "string" | Returns the origin type of the created origin |
| originProtocolPolicy | string | "string" | Returns the origin protocol policy of the created origin |
| httpsPort | integer($int32) | 0 | Returns the https port that origin listens on |
| httpPort | integer($int32) | 0 | Returns the http port that origin listens on |
| originResponseTimeout | integer($int32) | 0 | Returns the amount of time in seconds that CDN waits for a response from an origin |
| originKeepAliveTimeout | integer($int32) | 0 | Returns the amount of time in seconds that CDN maintains an ideal connection with an origin server before closing the connection |
| originConnectionAttempts | integer($int32) | 0 | Returns the number of time that CDN attends to connect to the origin |
| originConnectionTimeout | integer($int32) | 0 | Returns the amount of time in seconds that CDN waits when trying to establish a connection to origin |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
POST Origins#
Create a new origin
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/origins |
| Headers | Authorization |
| Parameters | distributionId, projectId, version |
| Body | { id, distributionId, domainName,path, originId, minimumOriginSslProtocol, originProtocolPolicy, httpPort, httpsPort, originResponseTimeout, originKeepAliveTimeout, connectionAttempts, connectionTimeout, customHeaders, id, originId, string, value} |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {distributionId} | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projctId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty project configuration is returned |
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| distributionId | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
Request body#
{ "id": 0, "distributionId": "string", "domainName": "string", "path": "string", "originId": "string", "minimumOriginSslProtocol": 0, "originProtocolPolicy": 0, "httpPort": 0, "httpsPort": 0, "originResponseTimeout": 0, "originKeepAliveTimeout": 0, "connectionAttempts": 0, "connectionTimeout": 0, "customHeaders": [ { "id": 0, "originId": 0, "name": "string", "value": "string" } ]}The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| id | Yes | integer($int32) | 0 | Sends the identifier of the origin entity |
| distributionId | Yes | string | "string" | Sends the identifier of the distribution |
| domainName | Yes | string | "string" | Sends the domain name of the origin |
| path | Yes | string | "string" | Sends the path of your directory in your origin |
| originId | Yes | string | "string" | Sends the name of the origin that the user gave |
| minimumOriginSslProtocol | Yes | integer($int32) | "string" | Sends the minimum ssl protocol for CDN to use when it establishes an HTTPS connection to your origin |
| originProtocolPolicy | Yes | integer($int32) | "string" | Sends the selected origin protocol policy which can be HTTP only or HTTPS only, or Match the viewer |
| httpPort | Yes | integer($int32) | 0 | Sends the http port that origin listens to |
| httpsPort | Yes | integer($int32) | 0 | Sends the https port that origin listens to |
| originResponseTimeout | Yes | integer($int32) | 0 | Sends the amount of time in seconds that CDN waits for a response from an origin |
| originKeepAliveTimeout | Yes | integer($int32) | 0 | Sends the amount of time in seconds that CDN maintains an ideal connection with an origin server before closing the connection |
| connectionAttempts | No | integer($int32) | 0 | Sends the number of time that CDN attends to connect to the origin |
| connectionTimeout | No | string | "string" | Sends the amount of time in seconds that CDN waits when trying to establish a connection to origin |
| customHeaders | Yes | array[object] | Sends an custom headers object of origins | |
| id | Yes | integer($int32) | 0 | Sends the identifier of the origin entity |
| originId | Yes | integer($int32) | 0 | Sends the name of the origin that the user gave |
| name | Yes | string | "string" | Sends the name of origin custom header in the distribution configuration |
| value | Yes | string | "string" | Sends the value of origin custom header in the distribution configuration |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": 0, "distributionId": "string", "domainName": "string", "path": "string", "originId": "string", "minimumOriginSslProtocol": 0, "minimumOriginSslProtocolOptions": [ { "id": 0, "value": "string" } ], "originProtocolPolicy": 0, "originProtocolPolicyOptions": [ { "id": 0, "value": "string" } ], "httpPort": 0, "httpsPort": 0, "originResponseTimeout": 0, "originKeepAliveTimeout": 0, "connectionAttempts": 0, "connectionTimeout": 0, "customHeaders": [ { "id": 0, "originId": 0, "name": "string", "value": "string" } ] }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns a behavior object | |
| id | integer($int32) | 0 | Returns the identifier of the origin entity |
| distributionId | string | "string" | Returns the identifier of the distribution |
| domainName | string | "string" | Returns the domain name of the origin |
| path | string | "string" | Returns the path of your directory in your origin |
| originId | string | "string" | Returns the name of the origin that the user gave |
| minimumOriginSslProtocol | integer($int32) | "string" | Returns the minimum ssl protocol for CDN to use when it establishes an HTTPS connection to your origin |
| minimumOriginSslProtocolOptions | array [object] | Returns the options of minimum ssl protocols which can be TLSv1.2, TLSv1.1, TLSv1, SSLv3 for CDN to use when it establishes an HTTPS connection to your origin | |
| id | integer($int32) | 0 | Returns the identifier of the origin entity |
| value | string | "string" | Returns the selected value of minimum origin ssl protocol options |
| originProtocolPolicy | integer($int32) | 0 | Returns the origin protocol policy which you want CDN to connect to your origin |
| originProtocolPolicyOptions | array [object] | Returns the selected origin protocol policy which can be HTTP only or HTTPS only, or Match the viewer | |
| id | integer($int32) | 0 | Returns the identifier of the origin entity |
| value | string | "string" | Returns the selected option of origin protocol policy depends on what you have chose |
| httpPort | integer($int32) | 0 | Returns the https port that origin listens on |
| httpsPort | integer($int32) | 0 | Returns the http port that origin listens on |
| originResponseTimeout | integer($int32) | 0 | Returns the amount of time in seconds that CDN waits for a response from an origin |
| originKeepAliveTimeout | integer($int32) | 0 | Returns the amount of time in seconds that CDN maintains an ideal connection with an origin server before closing the connection |
| connectionAttempts | integer($int32) | 0 | Returns the number of time that CDN attends to connect to the origin |
| connectionTimeout | string | "string" | Returns the amount of time in seconds that CDN waits when trying to establish a connection to origin |
| customHeaders | array[object] | Returns an custom headers object of origin | |
| id | integer($int32) | 0 | Returns the identifier of the origin entity |
| originId | integer($int32) | 0 | Returns the identifier of the origin entity |
| name | string | "string" | Returns the name of origin custom header in the distribution configuration |
| value | string | "string" | Returns the value of origin custom header in the distribution configuration |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 400 Bad Request
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
GET Origin#
Get the specified origin
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/origins/{id} |
| Headers | Authorization |
| Parameters | distributionId, version, projectId |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {distributionId} | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| {id} | Yes | integer($int32) | 0 | The origins's ID |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projectId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| version | Yes | string | v1 | Shows the version of API |
| distributionId | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| id | Yes | integer($int32) | 0 | The origins's ID |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": 0, "distributionId": "string", "domainName": "string", "path": "string", "originId": "string", "minimumOriginSslProtocol": 0, "minimumOriginSslProtocolOptions": [ { "id": 0, "value": "string" } ], "originProtocolPolicy": 0, "originProtocolPolicyOptions": [ { "id": 0, "value": "string" } ], "httpPort": 0, "httpsPort": 0, "originResponseTimeout": 0, "originKeepAliveTimeout": 0, "connectionAttempts": 0, "connectionTimeout": 0, "customHeaders": [ { "id": 0, "originId": 0, "name": "string", "value": "string" } ] }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns a behavior object | |
| id | integer($int32) | 0 | Returns the identifier of the origin entity |
| distributionId | string | "string" | Returns the identifier of the distribution |
| domainName | string | "string" | Returns the domain name of the origin |
| path | string | "string" | Returns the path of your directory in your origin |
| originId | string | "string" | Returns the name of the origin that the user gave |
| minimumOriginSslProtocol | integer($int32) | "string" | Returns the minimum ssl protocol for CDN to use when it establishes an HTTPS connection to your origin |
| minimumOriginSslProtocolOptions | array [object] | Returns the options of minimum ssl protocols which can be TLSv1.2, TLSv1.1, TLSv1, SSLv3 for CDN to use when it establishes an HTTPS connection to your origin | |
| id | integer($int32) | 0 | Returns the identifier of the origin entity |
| value | string | "string" | Returns the selected value of minimum origin ssl protocol options |
| originProtocolPolicy | integer($int32) | 0 | Returns the origin protocol policy which you want CDN to connect to your origin |
| originProtocolPolicyOptions | array [object] | Returns the selected origin protocol policy which can be HTTP only or HTTPS only, or Match the viewer | |
| id | integer($int32) | 0 | Returns the identifier of the origin entity |
| value | string | "string" | Returns the selected option of origin protocol policy depends on what you have chose |
| httpPort | integer($int32) | 0 | Returns the https port that origin listens on |
| httpsPort | integer($int32) | 0 | Returns the http port that origin listens on |
| originResponseTimeout | integer($int32) | 0 | Returns the amount of time in seconds that CDN waits for a response from an origin |
| originKeepAliveTimeout | integer($int32) | 0 | Returns the amount of time in seconds that CDN maintains an ideal connection with an origin server before closing the connection |
| connectionAttempts | integer($int32) | 0 | Returns the number of time that CDN attends to connect to the origin |
| connectionTimeout | string | "string" | Returns the amount of time in seconds that CDN waits when trying to establish a connection to origin |
| customHeaders | array[object] | Returns an custom headers object of origin | |
| id | integer($int32) | 0 | Returns the identifier of the origin entity |
| originId | integer($int32) | 0 | Returns the identifier of the origin entity |
| name | string | "string" | Returns the name of origin custom header in the distribution configuration |
| value | string | "string" | Returns the value of origin custom header in the distribution configuration |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
PUT Origins#
Updates the specified origin.
| PUT | |
|---|---|
| Method | PUT |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/origins/{id} |
| Headers | Authorization |
| Parameters | distributionId, version, projectId, id |
| Body | { id, distributionId, domainName,path, originId, minimumOriginSslProtocol, originProtocolPolicy, httpPort, httpsPort, originResponseTimeout, originKeepAliveTimeout, connectionAttempts, connectionTimeout, customHeaders, id, originId, string, value} |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {distributionId} | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| {id} | Yes | integer($int32) | 0 | The origins's ID |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projectId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| version | Yes | string | v1 | Shows the version of API |
| distributionId | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| id | Yes | integer($int32) | 0 | The origins's ID |
Request body#
{ "id": 0, "distributionId": "string", "domainName": "string", "path": "string", "originId": "string", "minimumOriginSslProtocol": 0, "originProtocolPolicy": 0, "httpPort": 0, "httpsPort": 0, "originResponseTimeout": 0, "originKeepAliveTimeout": 0, "connectionAttempts": 0, "connectionTimeout": 0, "customHeaders": [ { "id": 0, "originId": 0, "name": "string", "value": "string" } ]}The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| id | Yes | integer($int32) | 0 | Sends the identifier of the origin entity |
| distributionId | Yes | string | "string" | Sends the identifier of the distribution |
| domainName | Yes | string | "string" | Sends the domain name of the origin |
| path | Yes | string | "string" | Sends the path of your directory in your origin |
| originId | Yes | string | "string" | Sends the name of the origin that the user gave |
| minimumOriginSslProtocol | Yes | integer($int32) | "string" | Sends the minimum ssl protocol for CDN to use when it establishes an HTTPS connection to your origin |
| originProtocolPolicy | Yes | integer($int32) | "string" | Sends the selected origin protocol policy which can be HTTP only or HTTPS only, or Match the viewer |
| httpPort | Yes | integer($int32) | 0 | Sends the http port that origin listens to |
| httpsPort | Yes | integer($int32) | 0 | Sends the https port that origin listens to |
| originResponseTimeout | Yes | integer($int32) | 0 | Sends the amount of time in seconds that CDN waits for a response from an origin |
| originKeepAliveTimeout | Yes | integer($int32) | 0 | Sends the amount of time in seconds that CDN maintains an ideal connection with an origin server before closing the connection |
| connectionAttempts | No | integer($int32) | 0 | Sends the number of time that CDN attends to connect to the origin |
| connectionTimeout | No | string | "string" | Sends the amount of time in seconds that CDN waits when trying to establish a connection to origin |
| customHeaders | Yes | array[object] | Sends an custom headers object of origins | |
| id | Yes | integer($int32) | 0 | Sends the identifier of the origin entity |
| originId | Yes | integer($int32) | 0 | Sends the name of the origin that the user gave |
| name | Yes | string | "string" | Sends the name of origin custom header in the distribution configuration |
| value | Yes | string | "string" | Sends the value of origin custom header in the distribution configuration |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": 0, "distributionId": "string", "domainName": "string", "path": "string", "originId": "string", "minimumOriginSslProtocol": 0, "minimumOriginSslProtocolOptions": [ { "id": 0, "value": "string" } ], "originProtocolPolicy": 0, "originProtocolPolicyOptions": [ { "id": 0, "value": "string" } ], "httpPort": 0, "httpsPort": 0, "originResponseTimeout": 0, "originKeepAliveTimeout": 0, "connectionAttempts": 0, "connectionTimeout": 0, "customHeaders": [ { "id": 0, "originId": 0, "name": "string", "value": "string" } ] }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns a behavior object | |
| id | integer($int32) | 0 | Returns the identifier of the origin entity |
| distributionId | string | "string" | Returns the identifier of the distribution |
| domainName | string | "string" | Returns the domain name of the origin |
| path | string | "string" | Returns the path of your directory in your origin |
| originId | string | "string" | Returns the name of the origin that the user gave |
| minimumOriginSslProtocol | integer($int32) | "string" | Returns the minimum ssl protocol for CDN to use when it establishes an HTTPS connection to your origin |
| minimumOriginSslProtocolOptions | array [object] | Returns the options of minimum ssl protocols which can be TLSv1.2, TLSv1.1, TLSv1, SSLv3 for CDN to use when it establishes an HTTPS connection to your origin | |
| id | integer($int32) | 0 | Returns the identifier of the origin entity |
| value | string | "string" | Returns the selected value of minimum origin ssl protocol options |
| originProtocolPolicy | integer($int32) | 0 | Returns the origin protocol policy which you want CDN to connect to your origin |
| originProtocolPolicyOptions | array [object] | Returns the selected origin protocol policy which can be HTTP only or HTTPS only, or Match the viewer | |
| id | integer($int32) | 0 | Returns the identifier of the origin entity |
| value | string | "string" | Returns the selected option of origin protocol policy depends on what you have chose |
| httpPort | integer($int32) | 0 | Returns the https port that origin listens on |
| httpsPort | integer($int32) | 0 | Returns the http port that origin listens on |
| originResponseTimeout | integer($int32) | 0 | Returns the amount of time in seconds that CDN waits for a response from an origin |
| originKeepAliveTimeout | integer($int32) | 0 | Returns the amount of time in seconds that CDN maintains an ideal connection with an origin server before closing the connection |
| connectionAttempts | integer($int32) | 0 | Returns the number of time that CDN attends to connect to the origin |
| connectionTimeout | string | "string" | Returns the amount of time in seconds that CDN waits when trying to establish a connection to origin |
| customHeaders | array[object] | Returns an custom headers object of origin | |
| id | integer($int32) | 0 | Returns the identifier of the origin entity |
| originId | integer($int32) | 0 | Returns the identifier of the origin entity |
| name | string | "string" | Returns the name of origin custom header in the distribution configuration |
| value | string | "string" | Returns the value of origin custom header in the distribution configuration |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 400 Bad Request
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
DELETE Origins#
Deletes the specified origin
| DELETE | |
|---|---|
| Method | DELETE |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/invalidations/{id} |
| Headers | Authorization |
| Parameters | distributionId, version, projectId, id |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {distributionId} | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| {id} | Yes | integer($int32) | 0 | The origins's ID |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projectId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| version | Yes | string | v1 | Shows the version of API |
| distributionId | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| id | Yes | integer($int32) | 0 | The origins's ID |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": 0, "distributionId": "string", "domainName": "string", "path": "string", "originId": "string", "minimumOriginSslProtocol": 0, "minimumOriginSslProtocolOptions": [ { "id": 0, "value": "string" } ], "originProtocolPolicy": 0, "originProtocolPolicyOptions": [ { "id": 0, "value": "string" } ], "httpPort": 0, "httpsPort": 0, "originResponseTimeout": 0, "originKeepAliveTimeout": 0, "connectionAttempts": 0, "connectionTimeout": 0, "customHeaders": [ { "id": 0, "originId": 0, "name": "string", "value": "string" } ] }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns a behavior object | |
| id | integer($int32) | 0 | Returns the identifier of the origin entity |
| distributionId | string | "string" | Returns the identifier of the distribution |
| domainName | string | "string" | Returns the domain name of the origin |
| path | string | "string" | Returns the path of your directory in your origin |
| originId | string | "string" | Returns the name of the origin that the user gave |
| minimumOriginSslProtocol | integer($int32) | "string" | Returns the minimum ssl protocol for CDN to use when it establishes an HTTPS connection to your origin |
| minimumOriginSslProtocolOptions | array [object] | Returns the options of minimum ssl protocols which can be TLSv1.2, TLSv1.1, TLSv1, SSLv3 for CDN to use when it establishes an HTTPS connection to your origin | |
| id | integer($int32) | 0 | Returns the identifier of the origin entity |
| value | string | "string" | Returns the selected value of minimum origin ssl protocol options |
| originProtocolPolicy | integer($int32) | 0 | Returns the origin protocol policy which you want CDN to connect to your origin |
| originProtocolPolicyOptions | array [object] | Returns the selected origin protocol policy which can be HTTP only or HTTPS only, or Match the viewer | |
| id | integer($int32) | 0 | Returns the identifier of the origin entity |
| value | string | "string" | Returns the selected option of origin protocol policy depends on what you have chose |
| httpPort | integer($int32) | 0 | Returns the https port that origin listens on |
| httpsPort | integer($int32) | 0 | Returns the http port that origin listens on |
| originResponseTimeout | integer($int32) | 0 | Returns the amount of time in seconds that CDN waits for a response from an origin |
| originKeepAliveTimeout | integer($int32) | 0 | Returns the amount of time in seconds that CDN maintains an ideal connection with an origin server before closing the connection |
| connectionAttempts | integer($int32) | 0 | Returns the number of time that CDN attends to connect to the origin |
| connectionTimeout | string | "string" | Returns the amount of time in seconds that CDN waits when trying to establish a connection to origin |
| customHeaders | array[object] | Returns an custom headers object of origin | |
| id | integer($int32) | 0 | Returns the identifier of the origin entity |
| originId | integer($int32) | 0 | Returns the identifier of the origin entity |
| name | string | "string" | Returns the name of origin custom header in the distribution configuration |
| value | string | "string" | Returns the value of origin custom header in the distribution configuration |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found