Skip to content
API Enriched

Signup AWS Account.

POST
/no_auth/namespaces/system/aws/f5xc-saas/signup
curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/no_auth/namespaces/system/aws/f5xc-saas/signup \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "account_details": { "domain": "example", "locale": "example", "tos_accepted_at": "2026-04-15T12:00:00Z", "tos_version": "example" }, "account_id": "example", "company_details": { "mailing_address": { "address1": "example", "address2": "example", "city": "example", "country": "example", "county": "example", "phone_number": "example", "state": "example", "state_code": "example", "zip_code": "example" }, "name": "example" }, "crm_details": {}, "user_details": { "contact_number": "example", "email": "hello@example.com", "first_name": "example", "last_name": "example" } }'

Use this API to signup AWS account for F5XC service.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
AWSAccountSignupRequest
object
account_details
object
domain
Domain

Domain of the account.

string format: hostname
>= 26 characters <= 17 characters
locale
Locale

Locale of the account.

string
<= 16 characters
tos_accepted_at
TOS Accepted Timestamp

Terms of services accepted timestamp.

string format: date-time
<= 1024 characters
tos_version
TOS Version

Terms of services version.

string
<= 12 characters
account_id
account_id

Identifier for the aws_account object.

string
<= 1024 characters
company_details
object
mailing_address
object
address1
address1

Address line 1.

string
<= 1024 characters
address2
address2

Address line 2.

string
<= 1024 characters
city
city

City / town of the contact.

string
<= 1024 characters
country
country

Country of contact (e.g. USA). Refer to https://en.wikipedia.org/wiki/ISO_3166-1, column alpha-2.

string
<= 1024 characters
county
county

County (optional, for countries where they have counties)

string
<= 1024 characters
phone_number
phone_number

Phone number of the contact.

string
<= 1024 characters
state
state

State (optional, for countries where they have states)

string
<= 1024 characters
state_code
state code

State code (optional, for countries where they have states)

string
<= 1024 characters
zip_code
zip_code

Zip or postal code.

string
<= 1024 characters
name
Name

Name of the company.

string
>= 6 characters <= 256 characters
crm_details
object
user_details
object
contact_number
Contact Number

Contact number of the user.

string
<= 256 characters
email
E-mail

Email of the user.

string format: email
<= 256 characters /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/
first_name
First Name

First name of the user.

string
<= 256 characters
last_name
Last Name

Last name of the user.

string
<= 256 characters
Examplegenerated
{
  "account_details": {
    "domain": "example",
    "locale": "example",
    "tos_accepted_at": "2026-04-15T12:00:00Z",
    "tos_version": "example"
  },
  "account_id": "example",
  "company_details": {
    "mailing_address": {
      "address1": "example",
      "address2": "example",
      "city": "example",
      "country": "example",
      "county": "example",
      "phone_number": "example",
      "state": "example",
      "state_code": "example",
      "zip_code": "example"
    },
    "name": "example"
  },
  "crm_details": {},
  "user_details": {
    "contact_number": "example",
    "email": "hello@example.com",
    "first_name": "example",
    "last_name": "example"
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
AWSAccountSignupResponse
object
Examplegenerated
{}

401

Section titled “401”

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

403

Section titled “403”

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

404

Section titled “404”

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

409

Section titled “409”

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

429

Section titled “429”

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

Media typeapplication/json
string format: string
Examplegenerated
example

500

Section titled “500”

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

503

Section titled “503”

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

504

Section titled “504”

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example