Read Signup.

GET

/no_auth/signup/{name}

const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/no_auth/signup/example';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/no_auth/signup/example \
  --header 'Authorization: <Authorization>'

GET allows users to query signup and its status. Use this to query for a status of a submitted signup object.

Examples of this operation.

Authorizations

ApiToken

Parameters

Path Parameters

name

required

string

Signup name Name of the signup we want to retrieve . The name is returned after a signup object submission.

Responses

200

A successful response.

application/json

Get response

Signup object including its status. Use it when you want to see the progress of the signup flow.

object

object

object

metadata

object

annotations

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

object

description

description

Human readable description for the object.

string

>= 21 characters <= 1200 characters

disable

disable

A value of true will administratively disable the object.

boolean format: boolean

labels

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.

object

name

name

This is the name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API. The value of name has to follow DNS-1035 format. Required: YES.

string

>= 6 characters <= 1024 characters

namespace

namespace

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 ""

string

>= 6 characters <= 1024 characters

uid

uid

Uid is the unique in time and space value for this object. Object create will fail if provided by the client and the value exists in the system. Typically generated by the server on successful creation of an object and is not allowed to change once populated. Shadowed by SystemObjectMeta’s uid field.

string format: uuid

>= 36 characters <= 1024 characters

spec

object

gc_spec

object

billing_address

object

address1

address1

Network address or location

string

<= 1024 characters

address2

address2

Network address or location

string

<= 1024 characters

city

city

Configuration parameter for city

string

<= 1024 characters

contact_type

string

default: MAILING

Allowed values: MAILING BILLING PAYMENT

country

country

Configuration parameter for country

string

<= 1024 characters

county

county

Configuration parameter for county

string

<= 1024 characters

phone_number

phone_number

Configuration parameter for phone number

string

<= 1024 characters

state

state

Current state of the resource

string

<= 1024 characters

state_code

state code

Configuration parameter for state code

string

<= 1024 characters

zip_code

zip_code

IP address configuration

string

<= 1024 characters

billing_provider_account_id

billing_provider_account_id

ID of the billing provider account created to verify the billing info provided with this object. The ID is then used to ensure no more duplicate billing account is created.

string

<= 1024 characters

company

object

contacts

contacts

Contact information for user.

Array<object>

ObjectRefType

This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

domain_owner

Domain Owner

Domain owner is the first user who registered or signed up the associated Tenant. User created via signup flow will have this value set to true. Few restrictions apply to this user w.r.t role update and deletion.

boolean format: boolean

email

email

User’s email.

string format: email

<= 1024 characters /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/

first_name

first_name

User’s first name.

string

<= 1024 characters

groups

Groups

Reference to the user groups.

Array<object>

ObjectRefType

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

idm_type

string

default: SSO

Allowed values: SSO VOLTERRA_MANAGED UNDEFINED

last_login_timestamp

last_login_timestamp

Last successful login timestamp of the user.

string format: date-time

<= 1024 characters

last_name

last_name

User’s last name.

string

<= 1024 characters

locale

locale

Locale of the user (defaults to English)

string

<= 1024 characters

state

string

default: StateUndefined

Allowed values: StateUndefined StateCreating StateCreateFailed StateActive StateDisabled

sync_mode

string

default: SELF

Allowed values: SELF SCIM

tos_accepted

tos_accepted

Tos accepted version, this field is deprecated refer the fields tos_accepted_at and tos_version instead.

string

<= 1024 characters

tos_accepted_at

tos_accepted_at

Tos accepted timestamp.

string format: date-time

<= 1024 characters

tos_version

tos_version

Tos accepted version.

string

<= 1024 characters

type

string

default: USER

Allowed values: USER SERVICE DEBUG

company_contact

object

address1

address1

Network address or location

string

<= 1024 characters

address2

address2

Network address or location

string

<= 1024 characters

city

city

Configuration parameter for city

string

<= 1024 characters

contact_type

string

default: MAILING

Allowed values: MAILING BILLING PAYMENT

country

country

Configuration parameter for country

string

<= 1024 characters

county

county

Configuration parameter for county

string

<= 1024 characters

phone_number

phone_number

Configuration parameter for phone number

string

<= 1024 characters

state

state

Current state of the resource

string

<= 1024 characters

state_code

state code

Configuration parameter for state code

string

<= 1024 characters

zip_code

zip_code

IP address configuration

string

<= 1024 characters

company_name

company name

Company name (enterprise only)

string

<= 1024 characters

contact_number

contact_number

Phone contact number obsolete.

string

<= 1024 characters

crm_details

object

currency

currency

Preferred currency on the tenant level - individual billing accounts may override this.

string

<= 1024 characters

customer

object

contacts

contacts

Contact information for user.

Array<object>

ObjectRefType

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

domain_owner

Domain Owner

boolean format: boolean

email

email

User’s email.

string format: email

<= 1024 characters /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/

first_name

first_name

User’s first name.

string

<= 1024 characters

groups

Groups

Reference to the user groups.

Array<object>

ObjectRefType

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

idm_type

string

default: SSO

Allowed values: SSO VOLTERRA_MANAGED UNDEFINED

last_login_timestamp

last_login_timestamp

Last successful login timestamp of the user.

string format: date-time

<= 1024 characters

last_name

last_name

User’s last name.

string

<= 1024 characters

locale

locale

Locale of the user (defaults to English)

string

<= 1024 characters

state

string

default: StateUndefined

Allowed values: StateUndefined StateCreating StateCreateFailed StateActive StateDisabled

sync_mode

string

default: SELF

Allowed values: SELF SCIM

tos_accepted

tos_accepted

Tos accepted version, this field is deprecated refer the fields tos_accepted_at and tos_version instead.

string

<= 1024 characters

tos_accepted_at

tos_accepted_at

Tos accepted timestamp.

string format: date-time

<= 1024 characters

tos_version

tos_version

Tos accepted version.

string

<= 1024 characters

type

string

default: USER

Allowed values: USER SERVICE DEBUG

customer_contact

object

address1

address1

Network address or location

string

<= 1024 characters

address2

address2

Network address or location

string

<= 1024 characters

city

city

Configuration parameter for city

string

<= 1024 characters

contact_type

string

default: MAILING

Allowed values: MAILING BILLING PAYMENT

country

country

Configuration parameter for country

string

<= 1024 characters

county

county

Configuration parameter for county

string

<= 1024 characters

phone_number

phone_number

Configuration parameter for phone number

string

<= 1024 characters

state

state

Current state of the resource

string

<= 1024 characters

state_code

state code

Configuration parameter for state code

string

<= 1024 characters

zip_code

zip_code

IP address configuration

string

<= 1024 characters

domain

domain

Domain the customer chose to use - enterprise customers only.

string format: hostname

>= 26 characters <= 1024 characters

email

email

Email of the customer (ideally someone who’s responsible for the company account) obsolete.

string format: email

<= 1024 characters /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/

first_name

first_name

First name of the customer obsolete.

string

<= 1024 characters

infraprotect_info

object

arbor_cid

L3/L4 CID

L3/L4 provider customer ID.

string

<= 1024 characters

as_path_choice_full

object

as_path_choice_none

object

as_path_choice_origin

object

asn

asn

AS Number

integer format: int32

default_tunnel_bgp_secret

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.

string format: uri

<= 131072 characters

default_tunnel_bgp_secret_none

object

policer

object

bandwidth_max_mb

Bandwidth Max

Bandwidth max allowed for a customer defined by contract.

integer format: int64

prefixes

prefixes

List of tenant ‘super’ prefixes noted in CIDR.

Array<string>

primary_network_name

Primary Network Name

Name of the default customer network.

string

<= 1024 characters

reuse_ips

object

route_advertisement_mgmt_not_specified

object

route_advertisement_mgmt_not_using_f5xc

object

route_advertisement_mgmt_using_f5xc

object

use_dedicated_ips

object

uuid

uuid

Organisation UUID.

string format: uuid

<= 1024 characters

last_name

last_name

Last name of the customer (the superuser) obsolete.

string

<= 1024 characters

locale

locale

Locale of this sign up Required: YES.

string

<= 1024 characters

payment_provider_token

payment_provider_token

Payment provider token (for credit card details)

string

<= 1024 characters

support_plan_name

support_plan_name

What sort of support plan the customer will be on.

string

<= 1024 characters

tax_exempt

string

default: TAX_UNKNOWN

Allowed values: TAX_UNKNOWN TAX_REGULAR TAX_EXEMPT_UNVERIFIED TAX_EXEMPT_VERIFIED TAX_EXEMPT_VERIFICATION_FAILED TAX_EXEMPT_VERIFICATION_PENDING

token

token of the user

Token of the user requesting for. Valid tokens are internally generated in the system and shared with respective customers. Onboarding of new customers will proceed only when a valid token along with the email is provided during the signup process. Required: YES.

string

<= 1024 characters

tos_accepted

tos_accepted

T&c accepted date as millis from 01/01/1970 UTC.

string format: int64

<= 1024 characters

tos_accepted_at

tos_accepted_at

Tos accepted timestamp.

string format: date-time

<= 1024 characters

tos_version

version of terms of services the customer accepted

Indicates the version of ToS customer approved during signup. Any new version will require the customer to RE-approve during login.

string

<= 1024 characters

type

string

default: UNKNOWN

Allowed values: UNKNOWN FREEMIUM ENTERPRISE

usage_plan_name

usage_plan_name

What sort of usage plan the customer will be on.

string

<= 1024 characters

system_metadata

object

creation_timestamp

creation_timestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

string format: date-time

<= 1024 characters

creator_class

creator_class

A value identifying the class of the user or service which created this configuration object.

string

<= 1024 characters

creator_cookie

creator_cookie

This can used by the creator of the object for later audit for e.g. By storing the version identifying information of the object so at future it can be determined if version present at remote end is current or stale.

string

<= 1024 characters

creator_id

creator_id

A value identifying the exact user or service that created this configuration object.

string

<= 1024 characters

deletion_timestamp

deletion_timestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only.

string format: date-time

<= 1024 characters

direct_ref_hash

direct_ref_hash

A hash of the UIDs of direct references on this object. This can be used to determine if this object hash has had references become resolved/unresolved.

string

<= 1024 characters

finalizers

finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

Array<string>

initializers

object

pending

pending

Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.

Array<object>

InitializerType

Initializer is information about an initializer that has not yet completed.

object

name

name

Name of the service that is responsible for initializing this object.

string

>= 6 characters <= 1024 characters

result

object

code

code

Suggested HTTP return code for this status, 0 if not set.

integer format: int32

reason

reason

A human-readable description of why this operation is in the “Failure” status. If this value is empty there is no information available.

string

>= 27 characters <= 1024 characters

status

status

Status of the operation. One of: “Success” or “Failure”.

string

>= 17 characters <= 1024 characters

labels

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).

object

modification_timestamp

modification_timestamp

ModificationTimestamp is a timestamp representing the server time when this object was last modified.

string format: date-time

<= 1024 characters

namespace

namespace

The namespace this object belongs to. This is populated by the service based on the metadata.namespace field when an object is created.

Array<object>

>= 6 characters <= 6 characters <= 1 items

ObjectRefType

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

object_index

object_index

Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.

integer format: int64

owner_view

object

kind

kind

Kind of the view object.

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

uid

uid

UID of the view object.

string format: uuid

>= 36 characters <= 1024 characters

revision

revision

A revision number which always increases with each modification of the object in storage This doesn’t necessarily increase sequentially, but should always increase. This will be 0 when first created, and before any modifications.

string format: int64

<= 1024 characters

sre_disable

sre_disable

This should be set to true If F5XC/SRE operator wants to suppress an object from being presented to business-logic of a daemon(e.g. Due to bad-form/issue-causing Object). This is meant only to be used in temporary situations for operational continuity till a fix is rolled out in business-logic.

boolean format: boolean

tenant

tenant

Tenant to which this configuration object belongs to. The value for this is found from presented credentials.

string

>= 6 characters <= 1024 characters

trace_info

trace_info

Trace_info holds information(::) of the request doing the object modification. This can be used on the watch side to create subsequent spans. This information can be used to co-relate activities across services (modulo state compression) for a synchronous API.

string

<= 1024 characters

uid

uid

Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.

string format: uuid

>= 36 characters <= 1024 characters

vtrp_id

vtrp_id

Indicate origin of this object.

string

<= 1024 characters

vtrp_stale

vtrp_stale

Indicate whether mars deems this object to be stale via graceful restart timer information.

boolean format: boolean

status

Signup status object

Signup object status, including any failures.

Array<object>

>= 17 characters <= 17 characters

Signup status

Most recently observed status of signup object.

object

billingAccount

Billing account reference

Number of items or occurrences

Array<object>

ObjectRefType

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

conditions

conditions

Conditions.

Array<object>

ConditionType

Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.

object

hostname

hostname

Hostname of the instance of the site that sent the status.

string

<= 1024 characters

last_update_time

last_update_time

Last time the condition was updated.

string format: date-time

<= 1024 characters

reason

reason

A human readable string explaining the reason for reaching this condition.

string

>= 27 characters <= 1024 characters

service_name

service name

Name of the service that sent the status.

string

<= 1024 characters

status

status

Status of the condition “Success” Validation has succeeded. Requested operation was successful. “Failed” Validation has failed. “Incomplete” Validation of configuration has failed due to missing configuration. “Installed” Validation has passed and configuration has been installed in data path or K8s “Down” Configuration is operationally down. E.g. Down interface “Disabled” Configuration is administratively disabled i.e. objectmetatype.disable = true. “NotApplicable” Configuration is not applicable e.g. Tenant service_policy_set(s) in system namespace are not applicable on REs.

string

>= 17 characters <= 1024 characters

type

type

Type of the condition “Validation” represents validation user given configuration object “Operational” represents operational status of a given configuration object.

string

<= 1024 characters

metadata

object

creation_timestamp

creation_timestamp

Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.

string format: date-time

<= 1024 characters

creator_class

creator_class

Class of creator which created this StatusObject. This will be service’s DNS FQDN. This will be set by the system based on client certificate information.

string

<= 1024 characters

creator_id

creator_id

ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g. Identifying the environment also). This will be set by the system based on client certificate information.

string

<= 1024 characters

publish

string

default: STATUS_DO_NOT_PUBLISH

Allowed values: STATUS_DO_NOT_PUBLISH STATUS_PUBLISH

status_id

status_id

Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site and same service and potentially same daemon(creator-ID)

string

<= 1024 characters

uid

uid

Uid is the unique in time and space value for a StatusObject.

string format: uuid

>= 36 characters <= 1024 characters

vtrp_id

vtrp_id

Origin of this status exchanged by VTRP.

string

<= 1024 characters

vtrp_stale

vtrp_stale

Indicate whether mars deems this object to be stale via graceful restart timer information.

boolean format: boolean

object_refs

object_refs

Object reference.

Array<object>

ObjectRefType

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

tenant

Tenant reference

Tenant identifier for multi-tenancy

Array<object>

>= 6 characters <= 18 characters

ObjectRefType

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

user

User reference

Configuration parameter for user

Array<object>

ObjectRefType

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

Example

{
  "object": {
    "spec": {
      "gc_spec": {
        "billing_address": {
          "contact_type": "MAILING"
        },
        "company": {
          "idm_type": "SSO",
          "state": "StateUndefined",
          "sync_mode": "SELF",
          "type": "USER"
        },
        "company_contact": {
          "contact_type": "MAILING"
        },
        "customer": {
          "idm_type": "SSO",
          "state": "StateUndefined",
          "sync_mode": "SELF",
          "type": "USER"
        },
        "customer_contact": {
          "contact_type": "MAILING"
        },
        "tax_exempt": "TAX_UNKNOWN",
        "type": "UNKNOWN"
      }
    }
  },
  "status": [
    {
      "metadata": {
        "publish": "STATUS_DO_NOT_PUBLISH"
      }
    }
  ]
}

401

Returned when operation is not authorized.

application/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

application/json

string format: string

Example^generated

example

404

Returned when resource is not found.

application/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

application/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

application/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

application/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

application/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

application/json

string format: string

Example^generated

example

Read Signup.

Authorizations

Parameters

Path Parameters

Responses

200

Example

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

409

Examplegenerated

429

Examplegenerated

500

Examplegenerated

503

Examplegenerated

504

Examplegenerated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated