REST API reference

Platform API

Creates a new api key for the authenticated principal.

post

Header parameters

idempotencyKeyanyRequired

Responses

201

Success

application/json

400

Client error

application/problem+json

post

/api/apiKeys

HTTPcURLJavaScriptPython

POST /api/apiKeys HTTP/1.1
Accept: */*

{
  "type": {
    "value": {
      "value": {
        "length": 1,
        "isEmpty": true,
        "span": {
          "length": 1,
          "isEmpty": true
        }
      },
      "isDefault": true
    },
    "isDefault": true
  },
  "key": {
    "value": {
      "length": 1,
      "isEmpty": true,
      "span": {
        "length": 1,
        "isEmpty": true
      }
    },
    "isDefault": true
  }
}

Creates a new subscription.

post

Header parameters

idempotencyKeyanyRequired

Body

application/json

offerstring · min: 1Required

namestring · min: 1Required

hostnamestring · min: 1Required

Responses

201

Success

application/json

400

Client error

application/problem+json

post

/api/subscriptions

HTTPcURLJavaScriptPython

POST /api/subscriptions HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "offer": "text",
  "name": "text",
  "hostname": "text"
}

{
  "type": {
    "value": {
      "value": {
        "length": 1,
        "isEmpty": true,
        "span": {
          "length": 1,
          "isEmpty": true
        }
      },
      "isDefault": true
    },
    "isDefault": true
  },
  "key": {
    "value": {
      "length": 1,
      "isEmpty": true,
      "span": {
        "length": 1,
        "isEmpty": true
      }
    },
    "isDefault": true
  }
}

Subscription API

Lists subscription's resource groups.

get

Responses

200

Success

application/json

descriptionstring · nullableOptional

Description of the resource group.

idstringRequired

Fully qualified identifier of the resource group

Example: /api/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}

namestringRequired

Name of the resource group.

resourceGroupIdstringRequired

Identifier of the resource group

Example: rg_1234

401

Unauthorized

get

/api/subscriptions/{subscriptionId}/resourceGroups

HTTPcURLJavaScriptPython

GET /api/subscriptions/{subscriptionId}/resourceGroups HTTP/1.1
Accept: */*

[
  {
    "description": "text",
    "id": "/api/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}",
    "name": "text",
    "resourceGroupId": "rg_1234",
    "tags": {
      "CustomerNumber": 1234,
      "Department": "Service"
    }
  }
]