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=9fd34ef4-5219-4b21-965a-2f05f9e87efb&isAllowed=true&parentResourceType=SYSTEM' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/resource-functionalities?resourceType=CLUSTER&functionalityType=ADD_HOST&resourceIds=9fd34ef4-5219-4b21-965a-2f05f9e87efb&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" : "9fd34ef4-5219-4b21-965a-2f05f9e87efb",
    "functionalities" : [ {
      "type" : "ADD_HOST",
      "isAllowed" : true
    }, {
      "type" : "REMOVE_HOST",
      "isAllowed" : false
    } ]
  } ]
}

1.3. Related APIs

[_getresourcefunctionalities] API [_getresourcesfunctionalitiesallowedglobal] API

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
}

2.2. Related APIs

[_getresourcefunctionalities] API [_getresourcesfunctionalitiesallowedglobal] API
Last updated 2025-03-21 15:13:04 +0530

Operations

GET

Get Resource Functionalities

PATCH

Update Resources Functionalities

GET

Get Resources Functionalities Allowed Global

Get Resource Functionalities Allowed Global Configuration

PATCH

Update Resources Functionalities 1

Update Resources Functionalities Is Allowed Global Configuration