Invalidations
GET Invalidations#
Get all distribution's invalidations.
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/invalidations |
| 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": [ { "invalidationId": "string", "status": "string", "dateTime": "2021-03-31T13:45:58.174Z" } ], "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 invalidations |
| invalidationId | string | "string" | Returns the identifiers of listed invalidations |
| status | string | "string" | Returns a status that displays a state which can be "Deploying" or "Deployed" |
| dateTime | date | 2021-03-30T09:30:22.892Z | Returns the last date and time that was created |
| 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 Invalidations#
Create a new invalidation
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/invalidations |
| Headers | Authorization |
| Parameters | distributionId, projectId, version |
| Body | {distributionId, objectPaths} |
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#
{ "distributionId": "string", "objectPaths": "string" }
The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| distributionId | Yes | string | "string" | Sends the identifier for the distribution which is pre-generated |
| objectPaths | Yes | string | "string" | Sends the object paths of the objects that you want to invalidate with this invalidation batch |
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, "invalidationId": "string", "statusId": 0, "distributionId": "string", "objectPaths": "string", "insertDate": "2021-03-31T13:50:53.697Z" }, "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 invalidations |
| invalidationId | string | "string" | Returns the identifiers of listed invalidations |
| status | string | "string" | Returns a status that displays a state which can be "Deploying" or "Deployed" |
| dateTime | date | 2021-03-30T09:30:22.892Z | Returns the last date and time that was created |
| 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
GET Invalidation#
Get the specified invalidation
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/invalidations/{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 invalidation'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 invalidation'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, "invalidationId": "string", "statusId": 0, "distributionId": "string", "objectPaths": "string", "insertDate": "2021-03-31T13:55:03.493Z" }, "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 invalidations |
| invalidationId | string | "string" | Returns the identifiers of listed invalidations |
| status | string | "string" | Returns a status that displays a state which can be "Deploying" or "Deployed" |
| dateTime | date | 2021-03-30T09:30:22.892Z | Returns the last date and time that was created |
| 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