Ceip APIs
APIs for managing CEIP status
1. Get CEIP Status
1.1. Steps
- Invoke the API.
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/system/ceip' -i -X GET \
-H 'Authorization: Bearer etYWRta....'
HTTP Request
GET /v1/system/ceip HTTP/1.1
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....
HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 83
{
"status" : "ENABLED",
"instanceId" : "3f39d4a1-78d2-11e8-af85-f1cf26258cdc"
}
2. Update CEIP Status
2.1. Steps
- Invoke the API.
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/system/ceip' -i -X PATCH \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer etYWRta....' \
-d '{
"status" : "ENABLE"
}'
HTTP Request
PATCH /v1/system/ceip HTTP/1.1
Content-Type: application/json
Content-Length: 25
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....
{
"status" : "ENABLE"
}
HTTP Response
HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /v1/tasks/3f39d4a1-78d2-11e8-af85-f1cf26258cdc
Content-Length: 79
{
"id" : "3f39d4a1-78d2-11e8-af85-f1cf26258cdc",
"status" : "IN_PROGRESS"
}
Track the task status using the "id" from the previous response. The GET URL is set in the header response and can be used directly. Refer to: Get a Task.
If the "status" is "IN_PROGRESS", the task is still in progress.
If the "status" is "SUCCESSFUL", the task is completed successfully.
If the "status" is "FAILED", the task can be re-executed.
Tip : To retry task refer to: Retry a Task.
Last updated 2022-01-24 06:18:36 PST
Operations
GET
Get Ceip Status
Get CEIP status
PATCH
Update Ceip Status
Opt-in or Opt-out of CEIP