Enable Client-Side Defense.

POST

/api/shape/csd/namespaces/system/init

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/shape/csd/namespaces/system/init \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com", "namespace": "example", "serviceType": "example" }'

• F5 Distributed Cloud Console

Enable Client-Side Defense feature for the tenant.

Examples of this operation.

Authorizations

• ApiToken

Request Body^required

Media typeapplication/json

InitRequest

Any payload to be passed on the Provision API.

object

email

Email Address for Notifications

Email Address for Notifications Required: YES.

string format: email

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

namespace

namespace

Namespace

string

>= 6 characters <= 1024 characters

serviceType

Service Type

CSD service type.

string

<= 1024 characters

Example^generated

{
  "email": "hello@example.com",
  "namespace": "example",
  "serviceType": "example"
}

Responses

200

A successful response.

Media typeapplication/json

InitResponse

Any payload to be return by Provision API.

object

isConfigured

IsConfigured

Client-Side defense service is configured.

boolean format: boolean

Example^generated

{
  "isConfigured": true
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

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

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example