Pscs APIs

APIs for managing PSCs

Table of Contents

Get a PSC
Get the PSCs

Note : The ipAddress field in request payload or response body are deprecated and will be removed. Please use fqdn field instead.

1. Get a PSC

1.1. Prerequisites API

The following data is required

ID of the PSC

1.2. Steps API

Invoke the API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/pscs/6e9f56aa-4afb-4101-91a0-1b011fab6241' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/pscs/6e9f56aa-4afb-4101-91a0-1b011fab6241 HTTP/1.1
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 284

{
  "id" : "6e9f56aa-4afb-4101-91a0-1b011fab6241",
  "fqdn" : "sfo-m01-vc01.rainpole.io",
  "ipAddress" : "10.0.0.6",
  "ssoDomainName" : "rainpole.io",
  "ssoSubDomainName" : "rainpole.io",
  "isReplica" : false,
  "domain" : {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
  }
}

1.3. Related APIs API

[_getpscs] API [_getpsc] API

2. Get the PSCs

2.1. Prerequisites API

None

2.2. Steps API

Invoke the API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/pscs' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/pscs HTTP/1.1
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 327

{
  "elements" : [ {
    "id" : "6e9f56aa-4afb-4101-91a0-1b011fab6241",
    "fqdn" : "sfo-m01-vc01.rainpole.io",
    "ipAddress" : "10.0.0.6",
    "ssoDomainName" : "rainpole.io",
    "ssoSubDomainName" : "rainpole.io",
    "isReplica" : false,
    "domain" : {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
    }
  } ]
}

2.3. Related APIs API

[_getpscs] API [_getpsc] API
Last updated 2024-06-21 01:22:12 -0700

Operations

GET

Get Psc

Retrieve details of a Platform Service Controller (PSC)

GET

Get Pscs

Retrieve a list of Platform Service Controller (PSC)