light-mode-image
Learn
API Reference

Signers

Create a VICAL signer

POST/v1/ecosystems/certificates/vical-signers

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/ecosystems/certificates/vical-signers" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "csrPem": "string",  "caId": "24c00dcc-a2d5-4635-ba3f-14dcbc0a8ea3",  "intermediateCaId": "c04f6eaa-7183-4dfc-a249-59f9e8b2ddde",  "active": false}

Retrieve all VICAL signers

GET/v1/ecosystems/certificates/vical-signers

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000
Default100
cursor?string

Starting point for the list of entries.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/ecosystems/certificates/vical-signers"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "active": true,      "certificatePem": "string",      "certificateFingerprint": "string",      "certificateData": {        "commonName": "string",        "country": "string",        "notAfter": "2019-08-24T14:15:22Z",        "notBefore": "2019-08-24T14:15:22Z"      },      "caId": "24c00dcc-a2d5-4635-ba3f-14dcbc0a8ea3",      "intermediateCaId": "c04f6eaa-7183-4dfc-a249-59f9e8b2ddde"    }  ],  "nextCursor": "string"}

Retrieve a VICAL signer

GET/v1/ecosystems/certificates/vical-signers/{vicalSignerId}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

vicalSignerId*string

Unique identifier of the VICAL signer.

Formatuuid

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/ecosystems/certificates/vical-signers/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "active": true,  "certificatePem": "string",  "certificateFingerprint": "string",  "certificateData": {    "commonName": "string",    "country": "string",    "notAfter": "2019-08-24T14:15:22Z",    "notBefore": "2019-08-24T14:15:22Z"  },  "caId": "24c00dcc-a2d5-4635-ba3f-14dcbc0a8ea3",  "intermediateCaId": "c04f6eaa-7183-4dfc-a249-59f9e8b2ddde"}

Update a VICAL signer

PUT/v1/ecosystems/certificates/vical-signers/{vicalSignerId}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

vicalSignerId*string

Unique identifier of the VICAL signer.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/ecosystems/certificates/vical-signers/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "active": true,  "certificatePem": "string",  "certificateFingerprint": "string",  "certificateData": {    "commonName": "string",    "country": "string",    "notAfter": "2019-08-24T14:15:22Z",    "notBefore": "2019-08-24T14:15:22Z"  },  "caId": "24c00dcc-a2d5-4635-ba3f-14dcbc0a8ea3",  "intermediateCaId": "c04f6eaa-7183-4dfc-a249-59f9e8b2ddde"}

Delete a VICAL signer

DELETE/v1/ecosystems/certificates/vical-signers/{vicalSignerId}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

vicalSignerId*string

Unique identifier of the VICAL signer.

Formatuuid

Response Body

application/json

application/json

curl -X DELETE "https://example.com/v1/ecosystems/certificates/vical-signers/497f6eca-6276-4993-bfeb-53cbbbba6f08"
Empty

How would you rate this page?

Last updated on

On this page