Distributions
GET Distributions#
Gets all distributions.
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions |
| Headers | Authorization |
| Parameters | projectId, version, PageIndex, PageSize |
| 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 |
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 |
| PageIndex | No | integer($int32) | 1 | How many pages |
| PageSize | No | integer($int32) | 2 | Paganed Data |
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": [ { "distributionId": "string", "domainName": "string", "comment": "string", "origins": [ "string" ], "alternateDomainNames": "string", "status": "string", "state": "string", "lastModifizked": "2021-03-30T09:30:22.892Z" } ], "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 get false |
| errors | string | "string" | Indicate if there was an error |
| messages | string | "string" | Returns the response message from back-end |
| result | array [object] | Returns an distribution object | |
| distributionId | string | "string" | The identifier for the distribution |
| domainName | string | "string" | Specify the domain name for your distribution - the captain Ceph storage or web server from which you want CDN to get your web content. |
| comment | string | "string" | Comment for the distribution |
| origins | array [] | "string" | Returns all the origins for each distribution |
| alternateDomainNames | string | "string" | Returns the specified alternate domain names in distribution configuration |
| status | string | "string" | Returns two alternative options In "Progress" which informs that the distribution is being currently deployed in all CDN cache servers, "Deployed" informs that the distribution or distribution update has been completed |
| state | string | "string" | Returns "Enabled" when first the distribution is created or updated, if you want do "Disable" a distribution you can disable it and it returns the disabled state |
| lastModified | date | 2021-03-30 T 09:30:22.892Z | Returns the last modified date for the distributions |
| resultInfo | object | Returs information about distribution | |
| totalCount | integer($int32) | 0 | Total number of objects in database |
| pageIndex | integer($int32) | 0 | Returns Current pageop paganed data |
| pageSize | integer($int32) | 0 | Returns Objects per page |
| totalPages | integer($int32) | 0 | Returns Total pages |
| hasNextPage | bool | true | Returns true if it has a next page, otherwise returns false |
| hasPreviousPage | bool | true | Returns true if it has a previous page, otherwise returns false |
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 Distribution#
Creates a new distribution
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions |
| Headers | Authorization |
| Parameters | projectId, version |
| Body | { projectId,stateId, priceClassId, alternateDomainNames,sslCertificateId,sslCertificateType, supportedHttpVersions, securityPolicyId, defaultRootObject, ipv6, comment, domainName, originPath, originId, customHeaders: [{ id, originId, name, value}], pathPattern,viewerProtocolPolicy, allowedHttpMethods,cachedHttpMethods, useCacheAndOriginRequestPolicy, cachePolicyId, originRequestPolicyId } |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the version of API |
Request body#
{ "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "stateId": 0, "priceClassId": 0, "alternateDomainNames": "string", "sslCertificateId": 0, "sslCertificateType": 0, "supportedHttpVersions": 0, "securityPolicyId": 0, "defaultRootObject": "string", "ipv6": true, "comment": "string", "domainName": "string", "originPath": "string", "originId": "string", "customHeaders": [ { "id": 0, "originId": 0, "name": "string", "value": "string" } ], "pathPattern": "string", "viewerProtocolPolicy": 0, "allowedHttpMethods": 0, "cachedHttpMethods": 0, "useCacheAndOriginRequestPolicy": true, "cachePolicyId": 0, "originRequestPolicyId": 0}
The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projectId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6" | Sends the identifier of the project |
| stateId | Yes | integer($int32) | 0 | Sends the identifier of the state of the distribution |
| priceClassId | Yes | integer($int32) | 0 | Sends the price class associated with the distribution settings |
| alternateDomainNames | Yes | string | "string" | Sends the specified alternate domain names in distribution configuration |
| sslCertificateId | Yes | integer($int32) | 0 | Sends the identifier of ssl certificate which you have selected in distribution configuration settinga |
| sslCertificateType | Yes | integer($int32) | 0 | Sends the selected ssl certificate which can either be default GjirafaTechCDN ssl certificate or constum ssl certificate |
| supportedHttpVersions | Yes | integer($int32) | 0 | Sends the http versions that you have selected in distribution settings |
| securityPolicyId | Yes | integer($int32) | 2 | Sends the identifier of policy |
| defaultRootObject | Yes | string | "string" | Sends the root object that you have specified in the distribution configuration |
| ipv6 | Yes | bool | true | Sends true if ipv6 is enabled and turns false if ipv6 is disabled |
| comment | Yes | string | "string" | Sends the comment of distribution configuration |
| alternateDomainNames | Yes | string | "string" | Sends the specified alternate domain names in distribution configuration |
| domainName | Yes | string | "string" | Sends the specified domain name for distribution - the captain Ceph storage or web server from which you want CDN to get your web content. |
| originPath | string | "string" | Sends the origin path (a directory in your origin domain name) that you have specified in your origin settings when creating a distribution | |
| originId | string | "string" | Sends the identifierfetifier for the origin that you specified in the origin settings when creating a distribution | |
| customHeaders | array [] | Sends all the custom header's key and value that you have specified in the origin settings when creating a distribution | ||
| id | integer($int32) | 0 | Sends the id of the distribution entity | |
| originId | integer($int32) | 0 | Sends the origin id that you have specified in the settings when creating a distribution | |
| name | string | "string" | Sends the name of origin custom header in the distribution configuration | |
| value | string | "string" | Sends the value of origin custom header in the distribution configuration | |
| pathPattern | Yes | string($uuid) | "string" | Sends path pattern that you've specified in the configuration |
| viewerProtocolPolicy | integer($int32) | 0 | Sends viewer protocol policy selection in behavior configuration, e.g returns HTTP and HTTPS, redirect HTTP to HTTPS or HTTPS only | |
| allowedHttpMethods | integer($int32) | 0 | Sends selected http methods in behavior configuration | |
| cachedHttpMethods | integer($int32) | 0 | Sends the http methods the user wants to cache for the cache behavior | |
| useCacheAndOriginRequestPolicy | Yes | bool | true | Sends true if it is compressed automatically, otherwise turns false |
| cachePolicyId | integer($int32) | 0 | Sends the identifier for the selected cache policy id | |
| originRequestPolicyId | integer($int32) | 0 | Sends the identifier for the selected origin request policy 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": { "distributionId": "string", "deliveryMethod": "string", "distributionStatus": 0, "distributionStatusOptions": [ { "id": 0, "value": "string" } ], "priceClass": 0, "priceClassOptions": [ { "id": 0, "value": "string" } ], "state": "string", "sslCertificate": "string", "domainName": "string", "comment": "string", "defaultRootObject": "string", "securityPolicy": 0, "securityPolicyOptions": [ { "id": 0, "value": "string" } ], "alternateDomainNames": "string", "supportedHttpVersions": 0, "supportedHttpVersionOptions": [ { "id": 0, "value": "string" } ], "ipv6": true, "lastModified": "2021-03-30T13:18:00.071Z" }, "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 get false |
| errors | string | "string" | Indicate if there was an error |
| messages | string | "string" | Returns the response message from back-end |
| result | array [object] | Returns an distribution object | |
| distributionId | string | "string" | Returns the distribution id that is automatically generated |
| deliveryMethod | string | "string" | Returns the delivery method of the distribution (Web or RTMP) |
| distributionStatus | integer($int32) | 0 | Returns the distribution status that is In Progress or Deployed |
| distributionStatusOptions | array [] | Returns an object of distribution status option with the key value pairs | |
| id | integer($int32) | 0 | Returns the id of distribution entity |
| value | string | "string" | Returns the value of distribution status options |
| priceClass | integer($int32) | 0 | Returns the selected price class (TBD) |
| priceClassOptions | string | "string" | Returns the selected price class (TBD) |
| id | integer($int32) | 0 | Returns the id of distribution entity |
| value | string | "string" | Returns the value of distribution status options |
| state | string | "string" | Returns the state of distribution (Enabled or Disabled) |
| sslCertificate | string | "string" | Returns the selected ssl Certificate |
| domainName | string | "string" | Returns the specified domain name for distribution - the captain Ceph storage or web server from which you want CDN to get your web content. |
| comment | string | "string" | Returns the comment of the distribution |
| defaultRootObject | string | "string" | Returns the root object that you have specified in the distribution configuration |
| securityPolicy | integer($int32) | 0 | |
| securityPolicyOptions | array[] | ||
| id | integer($int32) | 0 | Returns the id of distribution entity |
| value | string | "string" | |
| ipv6 | bool | true | Returns true if ipv6 is enabled and turns false if ipv6 is disabled |
| lastModified | date | 2021-03-30T13:18:00.071Z | Returns last modified date of distribution |
| resultInfo | object | Returs information about distribution | |
| totalCount | integer($int32) | 0 | Total number of objects in database |
| pageIndex | integer($int32) | 0 | Returns Current pageop paganed data |
| pageSize | integer($int32) | 0 | Returns Objects per page |
| totalPages | integer($int32) | 0 | Returns Total pages |
| hasNextPage | bool | true | Returns true if it has a next page, otherwise returns false |
| hasPreviousPage | bool | true | Returns true if it has a previous page, otherwise returns false |
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
GET Distribution#
Gets the distribution by distributionId
| GET | |
|---|---|
| Method | GET By Id |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId} |
| 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 |
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 |
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": { "distributionId": "string", "deliveryMethod": "string", "distributionStatus": 0, "distributionStatusOptions": [ { "id": 0, "value": "string" } ], "priceClass": 0, "priceClassOptions": [ { "id": 0, "value": "string" } ], "state": "string", "sslCertificate": "string", "domainName": "string", "comment": "string", "defaultRootObject": "string", "securityPolicy": 0, "securityPolicyOptions": [ { "id": 0, "value": "string" } ], "alternateDomainNames": "string", "supportedHttpVersions": 0, "supportedHttpVersionOptions": [ { "id": 0, "value": "string" } ], "ipv6": true, "lastModified": "2021-03-30T14:39:02.765Z" }, "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 get false |
| errors | string | "string" | Indicate if there was an error |
| messages | string | "string" | Returns the response message from back-end |
| result | array [object] | Returns an distribution object | |
| distributionId | string | "string" | Returns the distribution id that is automatically generated |
| deliveryMethod | string | "string" | Returns the delivery method of the distribution (Web or RTMP) |
| distributionStatus | integer($int32) | 0 | Returns the distribution status that is In Progress or Deployed |
| distributionStatusOptions | array [] | Returns an object of distribution status option with the key value pairs | |
| id | integer($int32) | 0 | Returns the id of distribution entity |
| value | string | "string" | Returns the value of distribution status options |
| priceClass | integer($int32) | 0 | Returns the selected price class (TBD) |
| priceClassOptions | string | "string" | Returns the selected price class (TBD) |
| id | integer($int32) | 0 | Returns the id of distribution entity |
| value | string | "string" | Returns the value of distribution status options |
| state | string | "string" | Returns the state of distribution (Enabled or Disabled) |
| sslCertificate | string | "string" | Returns the selected ssl Certificate |
| domainName | string | "string" | Returns the specified domain name for distribution - the captain Ceph storage or web server from which you want CDN to get your web content. |
| comment | string | "string" | Returns the comment of the distribution |
| defaultRootObject | string | "string" | Returns the root object that you have specified in the distribution configuration |
| securityPolicy | integer($int32) | 0 | |
| securityPolicyOptions | array[] | ||
| id | integer($int32) | 0 | Returns the id of distribution entity |
| value | string | "string" | |
| ipv6 | bool | true | Returns true if ipv6 is enabled and turns false if ipv6 is disabled |
| lastModified | date | 2021-03-30T13:18:00.071Z | Returns last modified date of distribution |
| resultInfo | object | Returs information about distribution | |
| totalCount | integer($int32) | 0 | Total number of objects in database |
| pageIndex | integer($int32) | 0 | Returns Current pageop paganed data |
| pageSize | integer($int32) | 0 | Returns Objects per page |
| totalPages | integer($int32) | 0 | Returns Total pages |
| hasNextPage | bool | true | Returns true if it has a next page, otherwise returns false |
| hasPreviousPage | bool | true | Returns true if it has a previous page, otherwise returns false |
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 Distributions#
Updates the distribution by distributionId.
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId} |
| Headers | Authorization |
| Parameters | distributionId, version, projectId |
| Body | {stateId, priceClassId, alternateDomainNames, sslCertificateId, sslCertificateType, supportedHttpVersions, securityPolicyId, defaultRootObject, ipv6, comment} |
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) | 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 |
|---|---|---|---|---|
| projectId | Yes | string | The project's ID. If the ID is empty, an empty distribution 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#
{ "stateId": 0, "priceClassId": 0, "alternateDomainNames": "string", "sslCertificateId": 0, "sslCertificateType": 0, "supportedHttpVersions": 0, "securityPolicyId": 0, "defaultRootObject": "string", "ipv6": true, "comment": "string"}| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| stateId | Yes | integer($int32) | 0 | Sends the identifier of the state of the distribution |
| priceClassId | Yes | integer($int32) | 0 | Sends the price class associated with the distribution settings |
| alternateDomainNames | Yes | string | "string" | Sends the specified alternate domain names in distribution configuration |
| sslCertificateId | Yes | integer($int32) | 0 | Sends the identifier of ssl certificate which you have selected in distribution configuration settinga |
| sslCertificateType | Yes | integer($int32) | 0 | Sends the selected ssl certificate which can either be default GjirafaTechCDN ssl certificate or constum ssl certificate |
| supportedHttpVersions | Yes | integer($int32) | 0 | Sends the http versions that you have selected in distribution settings |
| securityPolicyId | Yes | integer($int32) | 2 | Sends the identifier of policy |
| defaultRootObject | Yes | string | "string" | Sends the root object that you have specified in the distribution configuration |
| ipv6 | Yes | bool | true | Sends true if ipv6 is enabled and turns false if ipv6 is disabled |
| comment | Yes | string | "string" | Sends the comment of 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": { "distributionId": "string", "deliveryMethod": "string", "distributionStatus": 0, "distributionStatusOptions": [ { "id": 0, "value": "string" } ], "priceClass": 0, "priceClassOptions": [ { "id": 0, "value": "string" } ], "state": "string", "sslCertificate": "string", "domainName": "string", "comment": "string", "defaultRootObject": "string", "securityPolicy": 0, "securityPolicyOptions": [ { "id": 0, "value": "string" } ], "alternateDomainNames": "string", "supportedHttpVersions": 0, "supportedHttpVersionOptions": [ { "id": 0, "value": "string" } ], "ipv6": true, "lastModified": "2021-03-30T15:19:43.170Z" }, "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 get false |
| errors | string | "string" | Indicate if there was an error |
| messages | string | "string" | Returns the response message from back-end |
| result | array [object] | Returns an distribution object | |
| distributionId | string | "string" | Returns the distribution id that is automatically generated |
| deliveryMethod | string | "string" | Returns the delivery method of the distribution (Web or RTMP) |
| distributionStatus | integer($int32) | 0 | Returns the distribution status that is In Progress or Deployed |
| distributionStatusOptions | array [] | Returns an object of distribution status option with the key value pairs | |
| id | integer($int32) | 0 | Returns the id of distribution entity |
| value | string | "string" | Returns the value of distribution status options |
| priceClass | integer($int32) | 0 | Returns the selected price class (TBD) |
| priceClassOptions | string | "string" | Returns the selected price class (TBD) |
| id | integer($int32) | 0 | Returns the id of distribution entity |
| value | string | "string" | Returns the value of distribution status options |
| state | string | "string" | Returns the state of distribution (Enabled or Disabled) |
| sslCertificate | string | "string" | Returns the selected ssl Certificate |
| domainName | string | "string" | Returns the specified domain name for distribution - the captain Ceph storage or web server from which you want CDN to get your web content. |
| comment | string | "string" | Returns the comment of the distribution |
| defaultRootObject | string | "string" | Returns the root object that you have specified in the distribution configuration |
| securityPolicy | integer($int32) | 0 | Returns |
| securityPolicyOptions | array[] | ||
| id | integer($int32) | 0 | Returns the id of distribution entity |
| value | string | "string" | Returns the value of distribution status options |
| ipv6 | bool | true | Returns true if ipv6 is enabled and turns false if ipv6 is disabled |
| lastModified | date | 2021-03-30T13:18:00.071Z | Returns last modified date of distribution |
| resultInfo | object | Returs information about distribution | |
| totalCount | integer($int32) | 0 | Total number of objects in database |
| pageIndex | integer($int32) | 0 | Returns Current pageop paganed data |
| pageSize | integer($int32) | 0 | Returns Objects per page |
| totalPages | integer($int32) | 0 | Returns Total pages |
| hasNextPage | bool | true | Returns true if it has a next page, otherwise returns false |
| hasPreviousPage | bool | true | Returns true if it has a previous page, otherwise returns false |
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 Distribution#
Deletes the distribution associated with this distributionId
| DELETE | |
|---|---|
| Method | DELETE |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId} |
| 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 |
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 |
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": { "distributionId": "string", "deliveryMethod": "string", "distributionStatus": 0, "distributionStatusOptions": [ { "id": 0, "value": "string" } ], "priceClass": 0, "priceClassOptions": [ { "id": 0, "value": "string" } ], "state": "string", "sslCertificate": "string", "domainName": "string", "comment": "string", "defaultRootObject": "string", "securityPolicy": 0, "securityPolicyOptions": [ { "id": 0, "value": "string" } ], "alternateDomainNames": "string", "supportedHttpVersions": 0, "supportedHttpVersionOptions": [ { "id": 0, "value": "string" } ], "ipv6": true, "lastModified": "2021-03-30T15:47:57.650Z" }, "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 get false |
| errors | string | "string" | Indicate if there was an error |
| messages | string | "string" | Returns the response message from back-end |
| result | array [object] | Returns an distribution object | |
| distributionId | string | "string" | Returns the distribution id that is automatically generated |
| deliveryMethod | string | "string" | Returns the delivery method of the distribution (Web or RTMP) |
| distributionStatus | integer($int32) | 0 | Returns the distribution status that is In Progress or Deployed |
| distributionStatusOptions | array [] | Returns an object of distribution status option with the key value pairs | |
| id | integer($int32) | 0 | Returns the id of distribution entity |
| value | string | "string" | Returns the value of distribution status options |
| priceClass | integer($int32) | 0 | Returns the selected price class (TBD) |
| priceClassOptions | string | "string" | Returns the selected price class (TBD) |
| id | integer($int32) | 0 | Returns the id of distribution entity |
| value | string | "string" | Returns the value of distribution status options |
| state | string | "string" | Returns the state of distribution (Enabled or Disabled) |
| sslCertificate | string | "string" | Returns the selected ssl Certificate |
| domainName | string | "string" | Returns the specified domain name for distribution - the captain Ceph storage or web server from which you want CDN to get your web content. |
| comment | string | "string" | Returns the comment of the distribution |
| defaultRootObject | string | "string" | Returns the root object that you have specified in the distribution configuration |
| securityPolicy | integer($int32) | 0 | |
| securityPolicyOptions | array[] | ||
| id | integer($int32) | 0 | Returns the id of distribution entity |
| value | string | "string" | Returns the value of distribution status options |
| ipv6 | bool | true | Returns true if ipv6 is enabled and turns false if ipv6 is disabled |
| lastModified | date | 2021-03-30T13:18:00.071Z | Returns last modified date of distribution |
| resultInfo | object | Returs information about distribution | |
| totalCount | integer($int32) | 0 | Total number of objects in database |
| pageIndex | integer($int32) | 0 | Returns Current pageop paganed data |
| pageSize | integer($int32) | 0 | Returns Objects per page |
| totalPages | integer($int32) | 0 | Returns Total pages |
| hasNextPage | bool | true | Returns true if it has a next page, otherwise returns false |
| hasPreviousPage | bool | true | Returns true if it has a previous page, otherwise returns false |
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