Ceip APIs

APIs for managing CEIP status

Table of Contents

Get CEIP Status
Update CEIP Status

1. Get CEIP Status

1.1. Steps API

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"
}

1.2. Related APIs API

[_getceipstatus] API [_setceipstatus] API

2. Update CEIP Status

2.1. Steps API

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: 131

{
  "id" : "3f39d4a1-78d2-11e8-af85-f1cf26258cdc",
  "status" : "IN_PROGRESS",
  "isCancellable" : false,
  "isRetryable" : false
}

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.

2.2. Related APIs API

[_getceipstatus] API [_setceipstatus] API [_gettask] API [_retrytask] API
Last updated 2024-08-27 16:13:54 -0700

Operations

GET

Get Ceip Status

Retrieve the CEIP status

PATCH

Set Ceip Status

Configure CEIP to Opt-In or Opt-Out