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" : "5963af0f-ee75-4040-9a29-1c8a3eff3387",
    "message" : "Some default warning message",
    "remediationMessage" : "Message with key [null.remedy]. Arguments:",
    "resourceId" : "fd3f243a-c1f2-41ee-bfb7-49abcfcd71bd",
    "resourceType" : "HOST",
    "resourceName" : "esxi-1.vrack.vsphere.local",
    "warningType" : "VALIDATION",
    "severity" : "MINOR",
    "occurredAtTimestamp" : "2023-10-02T16:14:29.000Z"
  }, {
    "id" : "1df64587-cd23-4a38-8ee4-86b7a1ac396e",
    "message" : "Some default warning message",
    "remediationMessage" : "Message with key [null.remedy]. Arguments:",
    "resourceId" : "de16bced-0f4d-4ee7-aa34-945b200ea199",
    "resourceType" : "HOST",
    "resourceName" : "esxi-1.vrack.vsphere.local",
    "warningType" : "VALIDATION",
    "severity" : "MINOR",
    "occurredAtTimestamp" : "2023-10-02T16:14:29.000Z"
  }, {
    "id" : "3d806fa1-9e3a-4c68-b259-acec7ac7c8f0",
    "message" : "Some default warning message",
    "remediationMessage" : "Message with key [null.remedy]. Arguments:",
    "resourceId" : "6e0b4763-2ae8-42a2-9355-bf0787b633f0",
    "resourceType" : "HOST",
    "resourceName" : "esxi-1.vrack.vsphere.local",
    "warningType" : "VALIDATION",
    "severity" : "MINOR",
    "occurredAtTimestamp" : "2023-10-02T16:14:29.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/092ccbf2-f7f5-44b7-9214-5981b893682c' -i -X GET \
    -H 'Accept-Language: fr' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/resource-warnings/092ccbf2-f7f5-44b7-9214-5981b893682c 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" : "092ccbf2-f7f5-44b7-9214-5981b893682c",
  "message" : "Some default warning message",
  "remediationMessage" : "Message with key [null.remedy]. Arguments:",
  "resourceId" : "a3b56d43-72fa-4e83-996f-676170a755a4",
  "resourceType" : "HOST",
  "resourceName" : "esxi-1.vrack.vsphere.local",
  "warningType" : "VALIDATION",
  "severity" : "MINOR",
  "occurredAtTimestamp" : "2023-10-02T16:14:29.000Z"
}

Last updated 2024-03-14 07:59:42 -0700

Operations

GET

Get Resource Warning

Get a Resource Warning by ID

GET

Get Resource Warnings