Resource Functionalities APIs

APIs for managing Resource Functionalities

Table of Contents

• Get Resource Functionalities

• Get Resource Functionalities Allowed Global Configuration

1. Get Resource Functionalities

1.1. Prerequisites

The following data is optional

• Resource type - if not provided the API will default to resource type SYSTEM

• Functionality type

• Resource IDs

• Allowed or disallowed resource functionalities

1.2. Steps

• Invoke the API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/resource-functionalities?resourceType=CLUSTER&functionalityType=ADD_HOST&resourceIds=f8216140-7462-4da0-b27e-09e36b0db032&isAllowed=true&parentResourceType=SYSTEM' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/resource-functionalities?resourceType=CLUSTER&functionalityType=ADD_HOST&resourceIds=f8216140-7462-4da0-b27e-09e36b0db032&isAllowed=true&parentResourceType=SYSTEM HTTP/1.1
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "resourceType" : "CLUSTER",
    "resourceId" : "f8216140-7462-4da0-b27e-09e36b0db032",
    "functionalities" : [ {
      "type" : "ADD_HOST",
      "isAllowed" : true
    }, {
      "type" : "REMOVE_HOST",
      "isAllowed" : false
    } ]
  } ]
}

2. Get Resource Functionalities Allowed Global Configuration

2.1. Steps

• Invoke the API.

cURL Request

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

HTTP Request

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

HTTP Response

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

{
  "isAllowed" : true
}

Last updated 2024-02-29 05:35:20 -0800