Skip to content

Generate CSR.

POST
/api/shape/bot/namespaces/{namespace}/certificate/generate-csr
curl --request POST \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/shape/bot/namespaces/example/certificate/generate-csr \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "common_name": "example", "country_name": "example", "csr_name": "example", "email": "hello@example.com", "locality": "example", "namespace": "example", "organization_name": "example", "organization_unit_name": "example", "san_main": "example", "san_sub": [ "example" ], "state": "example" }'

Generate a new CSR.

Examples of this operation.

namespace
required
string

Namespace

x-required.

Media typeapplication/json
GenerateCSRRequest

Request to generate CSR.

object
common_name
Common Name

Human-readable name for the resource

string
>= 1 characters <= 1024 characters
country_name
Country Name

Human-readable name for the resource

string
>= 1 characters <= 1024 characters
csr_name
CSR Name

Human-readable name for the resource

string
>= 1 characters <= 1024 characters
email
Email

Email address in RFC 5322 format

string format: email
>= 1 characters <= 1024 characters /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/
locality
Locality

Configuration parameter for locality

string
>= 1 characters <= 1024 characters
namespace
Namespace

Human-readable name for the resource

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

Human-readable name for the resource

string
>= 1 characters <= 1024 characters
organization_unit_name
Organization Unit Name

Human-readable name for the resource

string
>= 1 characters <= 1024 characters
san_main
SAN Main

Configuration parameter for san main

string
>= 1 characters <= 1024 characters
san_sub
SAN Sub

Configuration parameter for san sub

Array<string>
state
State

Current state of the resource

string
>= 1 characters <= 1024 characters
Examplegenerated
{
"common_name": "example",
"country_name": "example",
"csr_name": "example",
"email": "hello@example.com",
"locality": "example",
"namespace": "example",
"organization_name": "example",
"organization_unit_name": "example",
"san_main": "example",
"san_sub": [
"example"
],
"state": "example"
}

A successful response.

Media typeapplication/json
GenerateCSRResponse

Generated CSR content.

object
certificate_content
object
cert
Certificate

Configuration parameter for cert

string
<= 1024 characters
csr
CSR

Configuration parameter for csr

string
<= 1024 characters
id
ID

Unique identifier for the resource

string
<= 1024 characters
pkey
Private Key

Configuration parameter for pkey

string
<= 1024 characters
Examplegenerated
{
"certificate_content": {
"cert": "example",
"csr": "example",
"id": "example",
"pkey": "example"
}
}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

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

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example