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" : "f154d523-6a08-4738-9408-75d7ca29b773",
    "message" : "Some default warning message",
    "remediationMessage" : "Message with key [null.remedy]. Arguments:",
    "resourceId" : "a7289680-5810-4716-8053-7f74c347f688",
    "resourceType" : "HOST",
    "resourceName" : "esxi-1.vrack.vsphere.local",
    "warningType" : "VALIDATION",
    "severity" : "MINOR",
    "occurredAtTimestamp" : "2024-01-22T19:28:06.000Z"
  }, {
    "id" : "eb50161e-1fc3-434f-bd24-38dd2c5be6dc",
    "message" : "Some default warning message",
    "remediationMessage" : "Message with key [null.remedy]. Arguments:",
    "resourceId" : "706c8a14-315c-457b-a006-ff6144b6698f",
    "resourceType" : "HOST",
    "resourceName" : "esxi-1.vrack.vsphere.local",
    "warningType" : "VALIDATION",
    "severity" : "MINOR",
    "occurredAtTimestamp" : "2024-01-22T19:28:06.000Z"
  }, {
    "id" : "ef211ac5-e564-44e7-8df9-15be95c658c8",
    "message" : "Some default warning message",
    "remediationMessage" : "Message with key [null.remedy]. Arguments:",
    "resourceId" : "7ba23e36-d685-49cc-aaf4-66233120f0a9",
    "resourceType" : "HOST",
    "resourceName" : "esxi-1.vrack.vsphere.local",
    "warningType" : "VALIDATION",
    "severity" : "MINOR",
    "occurredAtTimestamp" : "2024-01-22T19:28:06.000Z"
  } ]
}

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/2600b947-572a-42dc-95a2-dca295bd48de' -i -X GET \
    -H 'Accept-Language: fr' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/resource-warnings/2600b947-572a-42dc-95a2-dca295bd48de 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" : "2600b947-572a-42dc-95a2-dca295bd48de",
  "message" : "Some default warning message",
  "remediationMessage" : "Message with key [null.remedy]. Arguments:",
  "resourceId" : "dee37a36-c865-45c1-8ed6-256712d91444",
  "resourceType" : "HOST",
  "resourceName" : "esxi-1.vrack.vsphere.local",
  "warningType" : "VALIDATION",
  "severity" : "MINOR",
  "occurredAtTimestamp" : "2024-01-22T19:28:06.000Z"
}

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