Error pages
GET Error Pages#
Returns the error pages of the organization
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/errorpages |
| 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 | 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": [ { "id": 0, "distributionId": "string", "httpErrorCode": "string", "errorCachingMinimumTtl": 0, "customizeErrorResponse": true, "httpResponseCode": "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 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 | |
| id | integer($int32) | 0 | Returns the identifiers of error pages |
| distributionId | string | "string" | Returns the identifiers of distributions |
| httpErrorCode | string | "string" | Returns the http error code for all the created error pages |
| errorCachingMinimumTtl | integer($int32) | 0 | Returns the error of minimum ttl caching |
| customizeErrorResponse | bool | true | Returns true if custiomize error response is selected yes and returns false if no is selected |
| httpResponseCode | string | "string" | Returns the http response code of error page |
| 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 Error Page#
Creates a new error page
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/errorpages |
| Headers | Authorization |
| Parameters | distributionId, projectId, version |
| Body | { id, distributionId, httpErrorCode, errorCachingMinimumTtl, customizeErrorResponse, responsePage, httpResponseCode } |
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", "httpErrorCode": 0, "errorCachingMinimumTtl": 0, "customizeErrorResponse": true, "responsePage": "string", "httpResponseCode": 0}
The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| id | Yes | integer($int32) | 0 | Sends the identifier of error page |
| distributionId | Yes | string | "string" | Sends the idetifier of distribution |
| httpErrorCode | Yes | string | "string" | Sends http error code of error page |
| errorCachingMinimumTtl | Yes | integer($int32) | 0 | Sends error minimumTtl caching of error page |
| customizeErrorResponse | Yes | bool | true | Sends customized error response of error page |
| httpResponseCode | Yes | string | "string" | Sends http response code of error page |
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", "httpErrorCode": 0, "httpErrorCodeOptions": [ { "id": 0, "value": "string" } ], "errorCachingMinimumTtl": 0, "customizeErrorResponse": true, "responsePage": "string", "httpResponseCode": 0, "httpResponseCodeOptions": [ { "id": 0, "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 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 | |
| id | integer($int32) | 0 | Returns the identifiers of error pages |
| distributionId | string | "string" | Returns the identifiers of distributions |
| httpErrorCode | string | "string" | Returns the http error code for all the created error pages |
| httpResponseCode | array [object] | "string" | Returns an object of http response code of error page |
| errorCachingMinimumTtl | integer($int32) | 0 | Returns the error of minimum ttl caching |
| customizeErrorResponse | bool | true | Returns true if custiomize error response is selected yes and returns false if no is selected |
| responsePage | string | "string" | Returns the html response page of error page creation |
| httpResponseCode | string | "string" | Returns the http response code of error page |
| httpResponseCodeOptions | array [object] | integer($int32) | Returns an object of http response code for the selected options of error page |
| id | integer($int32) | 0 | Returns the idetifier of error page |
| value | string | "string" | Returns a HTTP status of error page |
| 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 Error Page#
Get the associated error page.
| GET | |
|---|---|
| Method | GET By Id |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/errorpages/{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 errorpage'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 errorpage'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", "httpErrorCode": 0, "httpErrorCodeOptions": [ { "id": 0, "value": "string" } ], "errorCachingMinimumTtl": 0, "customizeErrorResponse": true, "responsePage": "string", "httpResponseCode": 0, "httpResponseCodeOptions": [ { "id": 0, "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 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 | |
| id | integer($int32) | 0 | Returns the identifiers of error pages |
| distributionId | string | "string" | Returns the identifiers of distributions |
| httpErrorCode | string | "string" | Returns the http error code for all the created error pages |
| httpResponseCode | array [object] | "string" | Returns an object of http response code of error page |
| errorCachingMinimumTtl | integer($int32) | 0 | Returns the error of minimum ttl caching |
| customizeErrorResponse | bool | true | Returns true if custiomize error response is selected yes and returns false if no is selected |
| responsePage | string | "string" | Returns the html response page of error page creation |
| httpResponseCode | string | "string" | Returns the http response code of error page |
| httpResponseCodeOptions | array [object] | integer($int32) | Returns an object of http response code for the selected options of error page |
| id | integer($int32) | 0 | Returns the idetifier of error page |
| value | string | "string" | Returns a HTTP status of error page |
| 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 Error Page#
Updates an existing error page
| PUT | |
|---|---|
| Method | PUT |
| URL or EndPoint | ​/api​/v{version}​/projects​/{projectId}​/distributions​/{distributionId}​/errorpages​/{id} |
| Headers | Authorization |
| Parameters | distributionId, version, projectId |
| Body | { id, distributionId, certificateBody, certificatePrivateKey, certificateChain } |
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 errorpage'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 errorpage's ID |
Request Body#
{ "id": 0, "distributionId": "string", "httpErrorCode": 0, "errorCachingMinimumTtl": 0, "customizeErrorResponse": true, "responsePage": "string", "httpResponseCode": 0}The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| id | Yes | integer($int32) | 0 | Sends the identifier of error page |
| distributionId | Yes | string | "string" | Sends the idetifier of distribution |
| httpErrorCode | Yes | string | "string" | Sends http error code of error page |
| errorCachingMinimumTtl | Yes | integer($int32) | 0 | Sends error minimumTtl caching of error page |
| customizeErrorResponse | Yes | bool | true | Sends customized error response of error page |
| httpResponseCode | Yes | string | "string" | Sends http response code of error page |
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", "httpErrorCode": 0, "httpErrorCodeOptions": [ { "id": 0, "value": "string" } ], "errorCachingMinimumTtl": 0, "customizeErrorResponse": true, "responsePage": "string", "httpResponseCode": 0, "httpResponseCodeOptions": [ { "id": 0, "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 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 | |
| id | integer($int32) | 0 | Returns the identifiers of error pages |
| distributionId | string | "string" | Returns the identifiers of distributions |
| httpErrorCode | string | "string" | Returns the http error code for all the created error pages |
| httpResponseCode | array [object] | "string" | Returns an object of http response code of error page |
| errorCachingMinimumTtl | integer($int32) | 0 | Returns the error of minimum ttl caching |
| customizeErrorResponse | bool | true | Returns true if custiomize error response is selected yes and returns false if no is selected |
| responsePage | string | "string" | Returns the html response page of error page creation |
| httpResponseCode | string | "string" | Returns the http response code of error page |
| httpResponseCodeOptions | array [object] | integer($int32) | Returns an object http response code of for selected options of error page |
| id | integer($int32) | 0 | Returns the idetifier of error page |
| value | string | "string" | Returns a HTTP status of error page |
| 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 Error Pages#
Delete the associated error page
| DELETE | |
|---|---|
| Method | DELETE |
| URL or EndPoint | ​/api​/v{version}​/projects​/{projectId}​/distributions​/{distributionId}​/errorpages​/{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 errorpage'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 errorpage'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", "httpErrorCode": 0, "httpErrorCodeOptions": [ { "id": 0, "value": "string" } ], "errorCachingMinimumTtl": 0, "customizeErrorResponse": true, "responsePage": "string", "httpResponseCode": 0, "httpResponseCodeOptions": [ { "id": 0, "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 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 | |
| id | integer($int32) | 0 | Returns the identifiers of error pages |
| distributionId | string | "string" | Returns the identifiers of distributions |
| httpErrorCode | string | "string" | Returns the http error code for all the created error pages |
| httpResponseCode | array [object] | "string" | Returns an object of http response code of error page |
| errorCachingMinimumTtl | integer($int32) | 0 | Returns the error of minimum ttl caching |
| customizeErrorResponse | bool | true | Returns true if custiomize error response is selected yes and returns false if no is selected |
| responsePage | string | "string" | Returns the html response page of error page creation |
| httpResponseCode | string | "string" | Returns the http response code of error page |
| httpResponseCodeOptions | array [object] | integer($int32) | Returns an object http response code of for selected options of error page |
| id | integer($int32) | 0 | Returns the idetifier of error page |
| value | string | "string" | Returns a HTTP status of error page |
| 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