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" : "3c27e3d2-2324-4cdd-8abf-f1dafd2be6d6",
    "message" : "Some default warning message",
    "remediationMessage" : "Message with key [null.remedy]. Arguments:",
    "resourceId" : "2157c8a4-d70c-4cf3-a0ad-506fd2414495",
    "resourceType" : "HOST",
    "resourceName" : "esxi-1.vrack.vsphere.local",
    "warningType" : "VALIDATION",
    "severity" : "MINOR",
    "occurredAtTimestamp" : "2023-05-16T02:29:35.000Z"
  }, {
    "id" : "1ea5f773-827d-4e47-95fd-d4ace6f8c86f",
    "message" : "Some default warning message",
    "remediationMessage" : "Message with key [null.remedy]. Arguments:",
    "resourceId" : "43271e03-71b2-4846-b2a6-9f2aa2d2be9c",
    "resourceType" : "HOST",
    "resourceName" : "esxi-1.vrack.vsphere.local",
    "warningType" : "VALIDATION",
    "severity" : "MINOR",
    "occurredAtTimestamp" : "2023-05-16T02:29:35.000Z"
  }, {
    "id" : "3f6615fa-5fb6-4625-99ad-7d759bf3a444",
    "message" : "Some default warning message",
    "remediationMessage" : "Message with key [null.remedy]. Arguments:",
    "resourceId" : "4417890f-6c1c-404d-aaf3-4912a33a2757",
    "resourceType" : "HOST",
    "resourceName" : "esxi-1.vrack.vsphere.local",
    "warningType" : "VALIDATION",
    "severity" : "MINOR",
    "occurredAtTimestamp" : "2023-05-16T02:29:35.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/c2aa9bdb-7296-4205-a379-8fd4cd3778fb' -i -X GET \
    -H 'Accept-Language: fr' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/resource-warnings/c2aa9bdb-7296-4205-a379-8fd4cd3778fb 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" : "c2aa9bdb-7296-4205-a379-8fd4cd3778fb",
  "message" : "Some default warning message",
  "remediationMessage" : "Message with key [null.remedy]. Arguments:",
  "resourceId" : "c205dfe8-8a1d-480e-9d7c-f2ed52b7a7b7",
  "resourceType" : "HOST",
  "resourceName" : "esxi-1.vrack.vsphere.local",
  "warningType" : "VALIDATION",
  "severity" : "MINOR",
  "occurredAtTimestamp" : "2023-05-16T02:29:36.000Z"
}

Last updated 2023-05-21 23:30:49 PDT

Operations

GET

Get Resource Warning

Get a Resource Warning by ID

GET

Get Resource Warnings