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

The following data is optional

ResourceType
ResourceIds

1.2. Steps

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" : "4002afc2-2a90-4e91-a722-71dbbd11578f",
    "message" : "Some default warning message",
    "remediationMessage" : "Message with key [null.remedy]. Arguments:",
    "resourceId" : "c68573e6-c46d-4a21-8372-eab80a223c1d",
    "resourceType" : "HOST",
    "resourceName" : "esxi-1.vrack.vsphere.local",
    "warningType" : "VALIDATION",
    "severity" : "MINOR",
    "occurredAtTimestamp" : "2025-03-21T09:42:54.000Z"
  }, {
    "id" : "fa848b84-1fac-4229-8986-27e887fd5409",
    "message" : "Some default warning message",
    "remediationMessage" : "Message with key [null.remedy]. Arguments:",
    "resourceId" : "e3fac4c1-307c-42b8-8750-4f2dfb9ac5db",
    "resourceType" : "HOST",
    "resourceName" : "esxi-1.vrack.vsphere.local",
    "warningType" : "VALIDATION",
    "severity" : "MINOR",
    "occurredAtTimestamp" : "2025-03-21T09:42:54.000Z"
  }, {
    "id" : "1a43c6aa-fd93-4f7b-99ab-2c6cf1552344",
    "message" : "Some default warning message",
    "remediationMessage" : "Message with key [null.remedy]. Arguments:",
    "resourceId" : "d8d0cd8c-2768-4273-a7ff-0f8ccf5483a4",
    "resourceType" : "HOST",
    "resourceName" : "esxi-1.vrack.vsphere.local",
    "warningType" : "VALIDATION",
    "severity" : "MINOR",
    "occurredAtTimestamp" : "2025-03-21T09:42:54.000Z"
  } ]
}

1.3. Related APIs

[_getresourcewarnings] API [_getresourcewarning] API

2. Get a Resource Warning by ID

2.1. Prerequisites

The following data is required

ID of the Resource Warning

2.2. Steps

Invoke the API.

cURL Request

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

HTTP Request

GET /v1/resource-warnings/ad0e7f53-7673-416b-beee-f980ace77043 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" : "ad0e7f53-7673-416b-beee-f980ace77043",
  "message" : "Some default warning message",
  "remediationMessage" : "Message with key [null.remedy]. Arguments:",
  "resourceId" : "5da95203-2c7d-4ffa-a0d7-38c6a0864a57",
  "resourceType" : "HOST",
  "resourceName" : "esxi-1.vrack.vsphere.local",
  "warningType" : "VALIDATION",
  "severity" : "MINOR",
  "occurredAtTimestamp" : "2025-03-21T09:42:54.000Z"
}

2.3. Related APIs

[_getresourcewarnings] API [_getresourcewarning] API
Last updated 2025-03-21 15:13:04 +0530

Operations

GET

Get Resource Warnings

POST

Create Resource Warning

Create a new Resource Warning

GET

Get Resource Warning

Get a Resource Warning by ID