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
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
- 200
- 401
- 403
- 404
- 409
- 429
- 500
- 503
- 504
{- "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.
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/jsonrequired
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
- Payload
{- "metadata": {
- "annotations": { },
- "description": "string",
- "disable": true,
- "labels": { },
- "name": "string",
- "namespace": "string"
}, - "spec": { }
}
Response samples
- 200
- 401
- 403
- 404
- 409
- 429
- 500
- 503
- 504
{- "metadata": {
- "annotations": { },
- "description": "string",
- "disable": true,
- "labels": { },
- "name": "string",
- "namespace": "string"
}, - "spec": {
- "state": "UNKNOWN"
}, - "system_metadata": {
- "creation_timestamp": "2019-08-24T14:15:22Z",
- "creator_class": "string",
- "creator_id": "string",
- "deletion_timestamp": "2019-08-24T14:15:22Z",
- "finalizers": [
- "string"
], - "initializers": {
- "pending": [
- {
- "name": "string"
}
], - "result": {
- "code": 0,
- "reason": "string",
- "status": "string"
}
}, - "labels": { },
- "modification_timestamp": "2019-08-24T14:15:22Z",
- "object_index": 0,
- "owner_view": {
- "kind": "string",
- "name": "string",
- "namespace": "string",
- "uid": "string"
}, - "tenant": "string",
- "uid": "string"
}
}
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.
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/jsonrequired
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
- Payload
{- "metadata": {
- "annotations": { },
- "description": "string",
- "disable": true,
- "labels": { },
- "name": "string",
- "namespace": "string"
}, - "spec": { }
}
Response samples
- 200
- 401
- 403
- 404
- 409
- 429
- 500
- 503
- 504
{ }
List Token
List the set of token in a namespace
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
- 200
- 401
- 403
- 404
- 409
- 429
- 500
- 503
- 504
{- "errors": [
- {
- "code": "EOK",
- "error_obj": {
- "type_url": "string",
- "value": "string"
}, - "message": "string"
}
], - "items": [
- {
- "annotations": { },
- "description": "string",
- "disabled": true,
- "get_spec": {
- "state": "UNKNOWN"
}, - "labels": { },
- "metadata": {
- "annotations": { },
- "description": "string",
- "disable": true,
- "labels": { },
- "name": "string",
- "namespace": "string"
}, - "name": "string",
- "namespace": "string",
- "owner_view": {
- "kind": "string",
- "name": "string",
- "namespace": "string",
- "uid": "string"
}, - "status_set": [
- {
- "conditions": [
- {
- "hostname": "string",
- "last_update_time": "2019-08-24T14:15:22Z",
- "reason": "string",
- "service_name": "string",
- "status": "string",
- "type": "string"
}
], - "metadata": {
- "creation_timestamp": "2019-08-24T14:15:22Z",
- "creator_class": "string",
- "creator_id": "string",
- "publish": "STATUS_DO_NOT_PUBLISH",
- "status_id": "string",
- "uid": "string",
- "vtrp_id": "string",
- "vtrp_stale": true
}, - "object_refs": [
- {
- "kind": "string",
- "name": "string",
- "namespace": "string",
- "tenant": "string",
- "uid": "string"
}
]
}
], - "system_metadata": {
- "creation_timestamp": "2019-08-24T14:15:22Z",
- "creator_class": "string",
- "creator_id": "string",
- "deletion_timestamp": "2019-08-24T14:15:22Z",
- "finalizers": [
- "string"
], - "initializers": {
- "pending": [
- {
- "name": "string"
}
], - "result": {
- "code": 0,
- "reason": "string",
- "status": "string"
}
}, - "labels": { },
- "modification_timestamp": "2019-08-24T14:15:22Z",
- "object_index": 0,
- "owner_view": {
- "kind": "string",
- "name": "string",
- "namespace": "string",
- "uid": "string"
}, - "tenant": "string",
- "uid": "string"
}, - "tenant": "string",
- "uid": "string"
}
]
}
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.
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
- 200
- 401
- 403
- 404
- 409
- 429
- 500
- 503
- 504
{- "create_form": {
- "metadata": {
- "annotations": { },
- "description": "string",
- "disable": true,
- "labels": { },
- "name": "string",
- "namespace": "string"
}, - "spec": { }
}, - "deleted_referred_objects": [
- {
- "kind": "string",
- "name": "string",
- "namespace": "string",
- "tenant": "string",
- "uid": "string"
}
], - "disabled_referred_objects": [
- {
- "kind": "string",
- "name": "string",
- "namespace": "string",
- "tenant": "string",
- "uid": "string"
}
], - "metadata": {
- "annotations": { },
- "description": "string",
- "disable": true,
- "labels": { },
- "name": "string",
- "namespace": "string"
}, - "referring_objects": [
- {
- "kind": "string",
- "name": "string",
- "namespace": "string",
- "tenant": "string",
- "uid": "string"
}
], - "replace_form": {
- "metadata": {
- "annotations": { },
- "description": "string",
- "disable": true,
- "labels": { },
- "name": "string",
- "namespace": "string"
}, - "spec": { }
}, - "spec": {
- "state": "UNKNOWN"
}, - "status": [
- {
- "conditions": [
- {
- "hostname": "string",
- "last_update_time": "2019-08-24T14:15:22Z",
- "reason": "string",
- "service_name": "string",
- "status": "string",
- "type": "string"
}
], - "metadata": {
- "creation_timestamp": "2019-08-24T14:15:22Z",
- "creator_class": "string",
- "creator_id": "string",
- "publish": "STATUS_DO_NOT_PUBLISH",
- "status_id": "string",
- "uid": "string",
- "vtrp_id": "string",
- "vtrp_stale": true
}, - "object_refs": [
- {
- "kind": "string",
- "name": "string",
- "namespace": "string",
- "tenant": "string",
- "uid": "string"
}
]
}
], - "system_metadata": {
- "creation_timestamp": "2019-08-24T14:15:22Z",
- "creator_class": "string",
- "creator_id": "string",
- "deletion_timestamp": "2019-08-24T14:15:22Z",
- "finalizers": [
- "string"
], - "initializers": {
- "pending": [
- {
- "name": "string"
}
], - "result": {
- "code": 0,
- "reason": "string",
- "status": "string"
}
}, - "labels": { },
- "modification_timestamp": "2019-08-24T14:15:22Z",
- "object_index": 0,
- "owner_view": {
- "kind": "string",
- "name": "string",
- "namespace": "string",
- "uid": "string"
}, - "tenant": "string",
- "uid": "string"
}
}
Delete Token
Delete the specified token
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/jsonrequired
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: |
namespace | string (namespace) Namespace in which the configuration object is present Example: |
Responses
Request samples
- Payload
{- "fail_if_referred": true,
- "name": "string",
- "namespace": "string"
}
Response samples
- 200
- 401
- 403
- 404
- 409
- 429
- 500
- 503
- 504
null
Set Token State
TokenState changes token status, it can be used to disable token.
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/jsonrequired
name | string (Token name) Token object name to change, it's usually same as Metadata.Uid Example: |
namespace | string (Token namespace) Namespace where token is residing Example: |
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
- Payload
{- "name": "string",
- "namespace": "string",
- "state": "UNKNOWN"
}
Response samples
- 200
- 401
- 403
- 404
- 409
- 429
- 500
- 503
- 504
{- "obj": {
- "metadata": {
- "annotations": { },
- "description": "string",
- "disable": true,
- "labels": { },
- "name": "string",
- "namespace": "string",
- "uid": "string"
}, - "spec": {
- "gc_spec": {
- "state": "UNKNOWN"
}
}, - "system_metadata": {
- "creation_timestamp": "2019-08-24T14:15:22Z",
- "creator_class": "string",
- "creator_cookie": "string",
- "creator_id": "string",
- "deletion_timestamp": "2019-08-24T14:15:22Z",
- "direct_ref_hash": "string",
- "finalizers": [
- "string"
], - "initializers": {
- "pending": [
- {
- "name": "string"
}
], - "result": {
- "code": 0,
- "reason": "string",
- "status": "string"
}
}, - "labels": { },
- "modification_timestamp": "2019-08-24T14:15:22Z",
- "namespace": [
- {
- "kind": "string",
- "name": "string",
- "namespace": "string",
- "tenant": "string",
- "uid": "string"
}
], - "object_index": 0,
- "owner_view": {
- "kind": "string",
- "name": "string",
- "namespace": "string",
- "uid": "string"
}, - "sre_disable": true,
- "tenant": "string",
- "trace_info": "string",
- "uid": "string",
- "vtrp_id": "string",
- "vtrp_stale": true
}
}
}