Example logo

Public REST API - OpenAPI 3.0 (0.0.1)

Download OpenAPI specification:

License: Apache 2.0

Control Center REST API definition.

jwt-authentication

Revoke all JWTs

Revoke all issued JWTs.

Authorizations:
basicAuthbearerToken
query Parameters
username
required
string

Username to revoke all issued JWTs from.

Responses

Response samples

Content type
application/problem+json
{
  • "code": "string",
  • "detail": "string"
}

Revoke JWT

Revoke a specific JWT.

Authorizations:
basicAuthbearerToken
path Parameters
token
required
string

JWT to revoke.

Responses

Response samples

Content type
application/json
{
  • "invalidParams": [
    • {
      • "name": "string",
      • "reason": "string"
      }
    ],
  • "detail": "string"
}

Get JWT

Get JWT for the user.

Request Body schema: application/json
required
username
required
string

Username.

password
required
string <password>

Password.

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "invalidParams": [
    • {
      • "name": "string",
      • "reason": "string"
      }
    ],
  • "detail": "string"
}

health

Inspect the health status of cluster.

Authorizations:
basicAuthbearerToken
path Parameters
connectionId
required
string <uuid>

Unique Connection ID.

Responses

Response samples

Content type
application/json
{
  • "status": "GOOD",
  • "reports": [
    • {
      • "reportName": "string",
      • "description": "string",
      • "status": "GOOD"
      }
    ]
}

Inspect the health report by the cluster.

Authorizations:
basicAuthbearerToken
path Parameters
connectionId
required
string <uuid>

Unique Connection ID.

reportName
required
string

Unique report name.

Responses

Response samples

Content type
application/json
{
  • "reportName": "string",
  • "description": "string",
  • "status": "GOOD"
}

nebula-v2

provision

Creates a cluster provisioning request.

Authorizations:
basicAuthbearerToken
Request Body schema: application/json
required
version
string (NebulaClusterVersionRequest)
Enum: "GG8" "GG9"

Managed cluster version.

clusterName
string

Cluster name.

cloudProviderRegion
string

Cloud provider region or availability zone.

clusterSize
string (NebulaInstanceSizeRequest)
Enum: "S" "M" "L"

The size of the AWS instance that is used for the cluster.

Array of objects (NebulaClusterDataRegionRequest)

Cluster storage data regions.

nodeCount
integer <int32> [ 1 .. 16 ]
Default: 1

The number of nodes in the cluster.

Array of objects (NebulaAccessRuleRequest)

The list of addresses that can connect to the cluster. If empty, any address is allowed.

object (PrivateLinkParametersRequest)

The list of account IDs that can work with the cluster's private link.

object (TdeParametersRequest)

Transparent Data Encryption information.

userLogin
string

User name.

userPassword
string <password> [ 8 .. 255 ] characters

User password.

azEnabled
boolean
Default: false

Enables multiple availability zones. Use this option to improve cluster stability.

Responses

Request samples

Content type
application/json
{
  • "version": "GG8",
  • "clusterName": "wonderful_hawking",
  • "cloudProviderRegion": "us-east-1",
  • "clusterSize": "S",
  • "igniteDataRegions": [
    • {
      • "name": "default",
      • "sizeInBytes": 0,
      • "persistence": false
      }
    ],
  • "nodeCount": 1,
  • "rules": [
    • {
      • "cidrIpv4": "10.0.0.0/8",
      • "description": "string"
      }
    ],
  • "privateLink": {
    • "accountIds": [
      • "string"
      ]
    },
  • "tde": {
    • "type": "AWS_KMS",
    • "cmkArn": "string",
    • "roleArn": "string",
    • "externalId": "string"
    },
  • "userLogin": "string",
  • "userPassword": "pa$$word",
  • "azEnabled": false
}

Response samples

Content type
application/json
{
  • "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
  • "clusterId": "a3d24843-7014-4490-bdd3-b7cb39b400c8",
  • "connectionInfo": {
    • "urls": [
      • "string"
      ]
    }
}

destroy

Destroys the specified nebula cluster.

Authorizations:
basicAuthbearerToken
path Parameters
connectionId
required
string <uuid>

The ID of the cluster to destroy.

Responses

Response samples

Content type
application/json
{
  • "invalidParams": [
    • {
      • "name": "string",
      • "reason": "string"
      }
    ],
  • "detail": "string"
}

AltStyle によって変換されたページ (->オリジナル) /