redocly logoAPI docs by Redocly

F5 Distributed Cloud Services API for ves.io.schema.token

Download OpenAPI specification:Download

token object is used to manage site admission. User must generate token before provisioning and pass this token to site during it's registration. Invalid tokens are refused and site with invalid token won't be able to join F5XC network. Single token can be used to register multiple sites.

Get Cloud Init Config

Returns cloud-init counfig for kvm provider with jwt token

Examples of this operation
query Parameters
provider
string

x-required x-example: "kvm" provider for that cloud-init config

site_name
string

site name for this cloud-init config

Responses

Response samples

Content type
application/json
{
  • "cloud_init_config": "string"
}

Create Token

Creates new token. token object is used to manage site admission. User must generate token before provisioning and pass this token to site during it's registration.

Examples of this operation
path Parameters
metadata.namespace
required
string

namespace

x-example: "staging" This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""

Request Body schema: application/json
required
object (ObjectCreateMetaType)

ObjectCreateMetaType is metadata that can be specified in Create request of an object.

spec
object (Create token)

Creates new token. token object is used to manage site admission. User must generate token before provisioning and pass this token to site during it's registration.

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "spec": { }
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "spec": {
    },
  • "system_metadata": {
    }
}

Replace Token

Replaces token. token object is used to manage site admission. User must generate token before provisioning and pass this token to site during it's registration.

Examples of this operation
path Parameters
metadata.namespace
required
string

namespace

x-example: "staging" This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""

metadata.name
required
string

name

x-example: "acmecorp-web" The configuration object to be replaced will be looked up by name

Request Body schema: application/json
required
object (ObjectReplaceMetaType)

ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.

spec
object (Replace token)

Replaces token. token object is used to manage site admission. User must generate token before provisioning and pass this token to site during it's registration.

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "spec": { }
}

Response samples

Content type
application/json
{ }

List Token

List the set of token in a namespace

Examples of this operation
path Parameters
namespace
required
string

namespace

x-example: "ns1" Namespace to scope the listing of token

query Parameters
label_filter
string

x-example: "env in (staging, testing), tier in (web, db)" A LabelSelectorType expression that every item in list response will satisfy

report_fields
Array of strings

x-example: "" Extra fields to return along with summary fields

report_status_fields
Array of strings

x-example: "" Extra status fields to return along with summary fields

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "items": [
    ]
}

Get Token

Get token. token object is used to manage site admission. User must generate token before provisioning and pass this token to site during it's registration.

Examples of this operation
path Parameters
namespace
required
string

namespace

x-example: "ns1" The namespace in which the configuration object is present

name
required
string

name

x-example: "name" The name of the configuration object to be fetched

query Parameters
response_format
string
Default: "GET_RSP_FORMAT_DEFAULT"
Enum: "GET_RSP_FORMAT_DEFAULT" "GET_RSP_FORMAT_FOR_CREATE" "GET_RSP_FORMAT_FOR_REPLACE" "GET_RSP_FORMAT_STATUS" "GET_RSP_FORMAT_READ" "GET_RSP_FORMAT_REFERRING_OBJECTS" "GET_RSP_FORMAT_BROKEN_REFERENCES"

The format in which the configuration object is to be fetched. This could be for example - in GetSpec form for the contents of object - in CreateRequest form to create a new similar object - to ReplaceRequest form to replace changeable values

Default format of returned resource Response should be in CreateRequest format Response should be in ReplaceRequest format Response should be in StatusObject(s) format Response should be in format of GetSpecType Response should have other objects referring to this object Response should have deleted and disabled objects referrred by this object

Responses

Response samples

Content type
application/json
{
  • "create_form": {
    },
  • "deleted_referred_objects": [
    ],
  • "disabled_referred_objects": [
    ],
  • "metadata": {
    },
  • "referring_objects": [
    ],
  • "replace_form": {
    },
  • "spec": {
    },
  • "status": [
    ],
  • "system_metadata": {
    }
}

Delete Token

Delete the specified token

Examples of this operation
path Parameters
namespace
required
string

namespace

x-example: "ns1" Namespace in which the configuration object is present

name
required
string

name

x-example: "name" Name of the configuration object

Request Body schema: application/json
required
fail_if_referred
boolean <boolean> (fail_if_referred)

Fail the delete operation if this object is being referred by other objects

name
string (name)

Name of the configuration object

Example: "name"

namespace
string (namespace)

Namespace in which the configuration object is present

Example: "ns1"

Responses

Request samples

Content type
application/json
{
  • "fail_if_referred": true,
  • "name": "string",
  • "namespace": "string"
}

Response samples

Content type
application/json
null

Set Token State

TokenState changes token status, it can be used to disable token.

Examples of this operation
path Parameters
namespace
required
string

Token namespace

x-example: "value" Namespace where token is residing

name
required
string

Token name

x-example: "value" Token object name to change, it's usually same as Metadata.Uid

Request Body schema: application/json
required
name
string (Token name)

Token object name to change, it's usually same as Metadata.Uid

Example: "value"

namespace
string (Token namespace)

Namespace where token is residing

Example: "value"

state
string (State)
Default: "UNKNOWN"
Enum: "UNKNOWN" "VALID" "EXPIRED"

Token state defines whether token can be used or node. VALID token is required, other states are invalid. Single token can be used to register multiple sites

Token state isn't set Token can be (re)used Token can't be used anymore

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "namespace": "string",
  • "state": "UNKNOWN"
}

Response samples

Content type
application/json
{
  • "obj": {
    }
}