Skip to content
API Enriched

Apply Certificate.

PUT
/api/shape/bot/namespaces/{namespace}/bot_infrastructures/{name}/apply-certificate
curl --request PUT \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/shape/bot/namespaces/example/bot_infrastructures/example/apply-certificate \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "namespace": "example", "region_list": [ { "cert_id": "example", "region_name": "AP_NORTHEAST_1" } ] }'

Apply custom certificate on Bot Infrastructure.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
namespace
required
string

Namespace x-required Namespace.

name
required
string

Bot Infrastructure Name x-required Bot Infrastructure Name.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ApplyCertificateRequest

Request for applying certificate.

object
name
Bot Infrastructure Name

Bot Infrastructure Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
namespace
Namespace

Namespace

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
region_list
Region List

List of region and certificate pairs to rollback.

Array<object>
>= 1 items
ApplyCertificateRequest

Request for applying certificate.

object
cert_id
Certificate ID

Certificate ID.

string
>= 1 characters <= 1024 characters
region_name
string
default: AP_NORTHEAST_1
Allowed values: AP_NORTHEAST_1 AP_NORTHEAST_3 AP_SOUTH_1 AP_SOUTH_2 AP_SOUTHEAST_1 AP_SOUTHEAST_2 AP_SOUTHEAST_3 EU_CENTRAL_1 EU_NORTH_1 EU_WEST_1 ME_SOUTH_1 ME_CENTRAL_1 SA_EAST_1 US_EAST_1 US_EAST_2 US_WEST_1 US_WEST_2 AF_SOUTH_1 GCP_ASIA_EAST1 GCP_ASIA_EAST2 GCP_ASIA_NORTHEAST1 GCP_ASIA_NORTHEAST2 GCP_ASIA_NORTHEAST3 GCP_ASIA_SOUTH1 GCP_ASIA_SOUTHEAST1 GCP_ASIA_SOUTHEAST2 GCP_AUSTRALIA_SOUTHEAST1 GCP_EUROPE_WEST1 GCP_EUROPE_WEST2 GCP_EUROPE_WEST3 GCP_NORTHAMERICA_NORTHEAST1 GCP_NORTHAMERICA_NORTHEAST2 GCP_SOUTHAMERICA_EAST1 GCP_SOUTHAMERICA_WEST1 GCP_US_CENTRAL1 GCP_US_EAST1 GCP_US_EAST4 GCP_US_WEST1 GCP_US_WEST2

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
CertificateOperationResponse

Response for certificate operations.

object
name
Cluster Name

Name of the cluster.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
region_list
Region List

List of region status for certificate operation.

Array<object>
CertificateOperationRegion

Region status for certificate operation.

object
cert_status
string
default: CERT_STATUS_UNDEFINED
Allowed values: CERT_STATUS_UNDEFINED CERT_STATUS_APPLIED CERT_STATUS_NOT_APPLIED
deploy_status
string
default: IN_PROGRESS
Allowed values: IN_PROGRESS FINISHED FAILED
region
string
default: AP_NORTHEAST_1
Allowed values: AP_NORTHEAST_1 AP_NORTHEAST_3 AP_SOUTH_1 AP_SOUTH_2 AP_SOUTHEAST_1 AP_SOUTHEAST_2 AP_SOUTHEAST_3 EU_CENTRAL_1 EU_NORTH_1 EU_WEST_1 ME_SOUTH_1 ME_CENTRAL_1 SA_EAST_1 US_EAST_1 US_EAST_2 US_WEST_1 US_WEST_2 AF_SOUTH_1 GCP_ASIA_EAST1 GCP_ASIA_EAST2 GCP_ASIA_NORTHEAST1 GCP_ASIA_NORTHEAST2 GCP_ASIA_NORTHEAST3 GCP_ASIA_SOUTH1 GCP_ASIA_SOUTHEAST1 GCP_ASIA_SOUTHEAST2 GCP_AUSTRALIA_SOUTHEAST1 GCP_EUROPE_WEST1 GCP_EUROPE_WEST2 GCP_EUROPE_WEST3 GCP_NORTHAMERICA_NORTHEAST1 GCP_NORTHAMERICA_NORTHEAST2 GCP_SOUTHAMERICA_EAST1 GCP_SOUTHAMERICA_WEST1 GCP_US_CENTRAL1 GCP_US_EAST1 GCP_US_EAST4 GCP_US_WEST1 GCP_US_WEST2
Example
{
  "region_list": [
    {
      "cert_status": "CERT_STATUS_UNDEFINED",
      "deploy_status": "IN_PROGRESS",
      "region": "AP_NORTHEAST_1"
    }
  ]
}

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