Resource Warnings APIs

APIs for managing Resource Warnings

Table of Contents

Get Resource Warnings
Get a Resource Warning by ID

1. Get Resource Warnings

1.1. Prerequisites API

The following data is optional

ResourceType
ResourceIds

1.2. Steps API

Invoke the API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/resource-warnings' -i -X GET \
    -H 'Accept-Language: fr' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/resource-warnings HTTP/1.1
Accept-Language: fr
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "483d9d76-85d0-451d-88da-814d037d15c6",
    "message" : "Some default warning message",
    "remediationMessage" : "Message with key [null.remedy]. Arguments:",
    "resourceId" : "9d463a56-4bba-4823-8ef7-a45c3b4e9b5f",
    "resourceType" : "HOST",
    "resourceName" : "esxi-1.vrack.vsphere.local",
    "warningType" : "VALIDATION",
    "severity" : "MINOR",
    "occurredAtTimestamp" : "2025-07-17T15:59:10.000Z"
  }, {
    "id" : "34bf56be-9fbb-47db-a65a-bf1bcbc42e51",
    "message" : "Some default warning message",
    "remediationMessage" : "Message with key [null.remedy]. Arguments:",
    "resourceId" : "22263a86-18b6-4dd8-95e1-b63e50812576",
    "resourceType" : "HOST",
    "resourceName" : "esxi-1.vrack.vsphere.local",
    "warningType" : "VALIDATION",
    "severity" : "MINOR",
    "occurredAtTimestamp" : "2025-07-17T15:59:10.000Z"
  }, {
    "id" : "b0b57d61-a11c-4b2b-a99f-940468fd0659",
    "message" : "Some default warning message",
    "remediationMessage" : "Message with key [null.remedy]. Arguments:",
    "resourceId" : "21b823b7-e58d-4f77-b0b8-ccc4b0bedf35",
    "resourceType" : "HOST",
    "resourceName" : "esxi-1.vrack.vsphere.local",
    "warningType" : "VALIDATION",
    "severity" : "MINOR",
    "occurredAtTimestamp" : "2025-07-17T15:59:10.000Z"
  } ]
}

1.3. Related APIs API

[_getresourcewarnings] API [_getresourcewarning] API

2. Get a Resource Warning by ID

2.1. Prerequisites API

The following data is required

ID of the Resource Warning

2.2. Steps API

Invoke the API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/resource-warnings/ef541921-1c8f-4b98-9b5a-ed4ca1fd85e1' -i -X GET \
    -H 'Accept-Language: fr' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/resource-warnings/ef541921-1c8f-4b98-9b5a-ed4ca1fd85e1 HTTP/1.1
Accept-Language: fr
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "ef541921-1c8f-4b98-9b5a-ed4ca1fd85e1",
  "message" : "Some default warning message",
  "remediationMessage" : "Message with key [null.remedy]. Arguments:",
  "resourceId" : "ad28cc33-be5f-44b6-8f4b-0aee091b229d",
  "resourceType" : "HOST",
  "resourceName" : "esxi-1.vrack.vsphere.local",
  "warningType" : "VALIDATION",
  "severity" : "MINOR",
  "occurredAtTimestamp" : "2025-07-17T15:59:11.000Z"
}

2.3. Related APIs API

[_getresourcewarnings] API [_getresourcewarning] API
Last updated 2025-07-17 07:18:23 -0700

Operations

GET

Get Resource Warnings

POST

Create Resource Warning

Create a new Resource Warning

GET

Get Resource Warning

Get a Resource Warning by ID