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" : "28ad34a6-5d91-4011-8978-13d12970deef",
    "message" : "Some default warning message",
    "remediationMessage" : "Message with key [null.remedy]. Arguments:",
    "resourceId" : "f4d5e058-8feb-4f7e-bf4e-f5ca868ee3c2",
    "resourceType" : "HOST",
    "resourceName" : "esxi-1.vrack.vsphere.local",
    "warningType" : "VALIDATION",
    "severity" : "MINOR",
    "occurredAtTimestamp" : "2024-08-27T20:11:08.000Z"
  }, {
    "id" : "ff9ea4d8-da4a-481e-b569-46a8c96e583a",
    "message" : "Some default warning message",
    "remediationMessage" : "Message with key [null.remedy]. Arguments:",
    "resourceId" : "4963f14e-2d5e-40ff-be56-628cec4593c9",
    "resourceType" : "HOST",
    "resourceName" : "esxi-1.vrack.vsphere.local",
    "warningType" : "VALIDATION",
    "severity" : "MINOR",
    "occurredAtTimestamp" : "2024-08-27T20:11:08.000Z"
  }, {
    "id" : "7c2831da-7220-4582-8231-312d2df83395",
    "message" : "Some default warning message",
    "remediationMessage" : "Message with key [null.remedy]. Arguments:",
    "resourceId" : "381365ac-cb54-47c9-b7ca-dc341830c084",
    "resourceType" : "HOST",
    "resourceName" : "esxi-1.vrack.vsphere.local",
    "warningType" : "VALIDATION",
    "severity" : "MINOR",
    "occurredAtTimestamp" : "2024-08-27T20:11:08.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/277ce8f7-00a7-49bc-92d7-9244b5315917' -i -X GET \
    -H 'Accept-Language: fr' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/resource-warnings/277ce8f7-00a7-49bc-92d7-9244b5315917 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" : "277ce8f7-00a7-49bc-92d7-9244b5315917",
  "message" : "Some default warning message",
  "remediationMessage" : "Message with key [null.remedy]. Arguments:",
  "resourceId" : "c5641684-8514-4fc8-a548-1ae8dd5f568c",
  "resourceType" : "HOST",
  "resourceName" : "esxi-1.vrack.vsphere.local",
  "warningType" : "VALIDATION",
  "severity" : "MINOR",
  "occurredAtTimestamp" : "2024-08-27T20:11:09.000Z"
}

2.3. Related APIs API

[_getresourcewarnings] API [_getresourcewarning] API
Last updated 2024-08-27 16:13:54 -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