Home ci 33. rest-api / endpoints: Epycbyte REST API Endpoints: Certs

33. rest-api / endpoints: Epycbyte REST API Endpoints: Certs

Last updated on Aug 05, 2025

Epycbyte REST API Endpoints: Certs

The Epycbyte REST API provides several endpoints to manage certificates. These endpoints allow you to retrieve, create, update, and delete certificates associated with your account or team.

Overview

The Certs API enables you to interact with certificate records stored in the Epycbyte system. Each certificate can be identified by its unique id and is associated with a specific team. The API supports various operations such as fetching a certificate by ID, issuing new certificates, updating existing ones, and deleting them.

Endpoints

1. Get Cert by ID

  • Method: GET
  • URL: /v7/certs/{id}
  • Path Parameter: id (required)
  • Query Parameters: slug, teamId
  • Response: Returns the certificate details including autoRenew, cns, createdAt, expiresAt, and id.

2. Issue a New Cert

  • Method: POST
  • URL: /v7/certs
  • Query Parameters: slug, teamId
  • Request Body: Contains an array of Common Name Strings (CNS) under the cns key.
  • Response: Returns the newly created certificate details.

3. Upload a Cert

  • Method: PUT
  • URL: /v7/certs
  • Query Parameters: slug, teamId
  • Request Body: Includes ca (Certificate Authority), cert (certificate content), key (private key), and optionally skipValidation.
  • Response: Returns the updated certificate details.

4. Delete a Cert

  • Method: DELETE
  • URL: /v7/certs/{id}
  • Path Parameter: id (required)
  • Query Parameters: slug, teamId
  • Response: Removes the specified certificate from the system.

Authentication

All API calls require an Authorization token, which should be included in the request headers as Authorization: Bearer {token}.

Response Codes

The API uses standard HTTP status codes to indicate success or failure. For example:

  • 200 OK: Indicates a successful operation.
  • 400 Bad Request: If there is an issue with the request parameters.
  • 403 Forbidden: When the user lacks the necessary permissions to perform the action.

This documentation provides comprehensive details on how to interact with Epycbyte's certificate management system via their REST API. Ensure you review the specific requirements for each endpoint before implementing them in your application.