Certificates

Create Certificate

post

Creates a new certificate for use with connector authentication.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Body

connector_idstring · nullableOptional

certificatestringRequired

passphrasestring · max: 1000 · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post/api/v1/certificates

POST /api/v1/certificates HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "connector_id": 1,
  "certificate": "example_certificate",
  "passphrase": "example_passphrase"
}

{
  "data": {
    "id": 1,
    "connector_id": 1,
    "certificate": "example_certificate",
    "passphrase": "example_passphrase",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "name": "My Example",
    "user_id": 1,
    "connector": {},
    "user": {}
  }
}

Delete Certificate

delete

Permanently deletes a specific certificate.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

certificatestringRequired

The certificate identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete/api/v1/certificates/{certificate}

DELETE /api/v1/certificates/{certificate} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "Action completed successfully."
}