API docs by Redocly

HEAT Cloud API (1.0.0)

Download OpenAPI specification:

Token

/api/v1/public/v1/token/exchange

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "Bearer",
  • "expires_in": 0
}

Sites

List every site available to the current users access group

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "sites": [
    ]
}

/api/v1/public/sites/{siteId}

Authorizations:
bearerAuth
path Parameters
siteId
required
string

Identifier of selected site

Responses

Response samples

Content type
application/json
{
  • "details": [
    ]
}

/api/v1/public/v1/sites/{siteId}/schedules

Authorizations:
bearerAuth
path Parameters
siteId
required
string <uuid>
Request Body schema: application/json
required
required
Array of objects or objects or objects [ 1 .. 192 ] items

Responses

Request samples

Content type
application/json
{
  • "schedules": [
    ]
}

Response samples

Content type
application/json
{
  • "batchId": "5579c111-9c50-47e2-af92-f16d52e63189",
  • "accepted": 0
}