Certificate revocation lists

CRLs

GET /certificates/crls

Returns a list of all Certificate Revocation List and their usages.

curl

curl -X GET "https://appliance.example.com/api/v1/certificates/crls" \
  -H "Authorization: Bearer $TOKEN"

PHP

<?php

$url = 'https://appliance.example.com/api/v1/certificates/crls';
$headers = [
    'Authorization: Bearer ' . $token,
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

Python

import requests

headers = {"Authorization": f"Bearer {token}"}

response = requests.get("https://appliance.example.com/api/v1/certificates/crls", headers=headers)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://appliance.example.com/api/v1/certificates/crls', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${token}`,
  },
});

const data = await response.json();

Response

{
  "status": "success",
  "message": "Certificate Revocation Lists",
  "data": [
    {
      "id": "5e1-c60-797-73b",
      "name": "base-mc-lbnode-1",
      "usage": {
        "userInterface": 1
      }
    }
  ]
}

POST /certificates/crls

Add a Certificate Revocation List

This change is staged. Send PUT /services/apply to apply it.

Body parameters

name string Required
crl string Required
pem string Required: if pem is provided, crl will be updated with pem

curl

curl -X POST "https://appliance.example.com/api/v1/certificates/crls" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "<name>",
  "crl": "<crl>",
  "pem": "<pem>"
}'

PHP

<?php

$url = 'https://appliance.example.com/api/v1/certificates/crls';
$headers = [
    'Authorization: Bearer ' . $token,
    'Content-Type: application/json',
];

$payload = [
    'name' => '<name>',
    'crl' => '<crl>',
    'pem' => '<pem>',
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POSTFIELDS => json_encode($payload),
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

Python

import requests

headers = {"Authorization": f"Bearer {token}"}
payload = {
    "name": "<name>",
    "crl": "<crl>",
    "pem": "<pem>"
}

response = requests.post("https://appliance.example.com/api/v1/certificates/crls", headers=headers, json=payload)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://appliance.example.com/api/v1/certificates/crls', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "name": "<name>",
  "crl": "<crl>",
  "pem": "<pem>"
}),
});

const data = await response.json();

Response

{
  "status": "success",
  "message": "New Certificate Revocation List: {name} successfully added",
  "data": {
    "id": "5e1-c83-a66-2ab"
  }
}

CRLs by ID

GET /certificates/crls/{id}

Returns a Certificate Revocation List.

Path parameters

id string Required

curl

curl -X GET "https://appliance.example.com/api/v1/certificates/crls/{id}" \
  -H "Authorization: Bearer $TOKEN"

PHP

<?php

$url = 'https://appliance.example.com/api/v1/certificates/crls/{id}';
$headers = [
    'Authorization: Bearer ' . $token,
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

Python

import requests

headers = {"Authorization": f"Bearer {token}"}

response = requests.get("https://appliance.example.com/api/v1/certificates/crls/{id}", headers=headers)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://appliance.example.com/api/v1/certificates/crls/{id}', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${token}`,
  },
});

const data = await response.json();

Response

{
  "status": "success",
  "message": "Certificate Revocation List",
  "data": {
    "id": "5e1-c60-797-73b",
    "name": "TEST",
    "crl": "-----BEGIN X509 CRL-----\nMIIBWTCB4QIBATAKBggqhkjOPQQDAjB5MQswCQYDVQQGEwJVUzENMAsGA1UECAwE\nTG9hZDERMA8GA1UEBwwIQmFsYW5jZXIxFjAUBgNVBAoMDUxvYWQgQmFsYW5jZXIx\nFDASBgNVBAsMC0RldmVsb3BtZW50MRowGAYDVQQDDBFsb2FkYmFsYW5jZXIudGVz\ndBcNMjQxMjA0MTM1MDIxWhcNMjUwMTAzMTM1MDIxWjAnMCUCFF4ToEQW…",
    "usage": {
      "userInterface": 1
    }
  }
}

PUT /certificates/crls/{id}

Edit a Certificate Revocation List

This change is staged. Send PUT /services/apply to apply it.

Path parameters

id string Required: .Body parameters

name string Required
crl string Required
pem string Required: if pem is provided, crl will be updated with pem

curl

curl -X PUT "https://appliance.example.com/api/v1/certificates/crls/{id}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "<name>",
  "crl": "<crl>",
  "pem": "<pem>"
}'

PHP

<?php

$url = 'https://appliance.example.com/api/v1/certificates/crls/{id}';
$headers = [
    'Authorization: Bearer ' . $token,
    'Content-Type: application/json',
];

$payload = [
    'name' => '<name>',
    'crl' => '<crl>',
    'pem' => '<pem>',
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POSTFIELDS => json_encode($payload),
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

Python

import requests

headers = {"Authorization": f"Bearer {token}"}
payload = {
    "name": "<name>",
    "crl": "<crl>",
    "pem": "<pem>"
}

response = requests.put("https://appliance.example.com/api/v1/certificates/crls/{id}", headers=headers, json=payload)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://appliance.example.com/api/v1/certificates/crls/{id}', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "name": "<name>",
  "crl": "<crl>",
  "pem": "<pem>"
}),
});

const data = await response.json();

Response

{
  "status": "success",
  "message": "Certificate Revocation List has been updated successfully"
}

DELETE /certificates/crls/{id}

Remove Certificate Revocation List by ID

This change is staged. Send PUT /services/apply to apply it.

Path parameters

id string Required

curl

curl -X DELETE "https://appliance.example.com/api/v1/certificates/crls/{id}" \
  -H "Authorization: Bearer $TOKEN"

PHP

<?php

$url = 'https://appliance.example.com/api/v1/certificates/crls/{id}';
$headers = [
    'Authorization: Bearer ' . $token,
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

Python

import requests

headers = {"Authorization": f"Bearer {token}"}

response = requests.delete("https://appliance.example.com/api/v1/certificates/crls/{id}", headers=headers)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://appliance.example.com/api/v1/certificates/crls/{id}', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${token}`,
  },
});

const data = await response.json();

Response

{
  "status": "success",
  "message": "Certificate Revocation List has been deleted"
}