Previous topic

API Reference

Next topic

Commands

This Page

Certificates

JSON-API Endpoints

GET /api/v1/certificates/

Retrieve a list of all metadata about certificates stored in the system.

Query Parameters:
 
  • page[size] – The number of items to return for each page
  • page[number] – The page to fetch
  • filter[] – An array of filtering rules
  • sort – A list of fields (separated by comma) to sort ascending. Mark with a - minus to denote descending sort.
Request Headers:
 
  • Accept – application/vnd.api+json
Response Headers:
 
POST /api/v1/certificates/

Add a new certificate to the system.

GET /api/v1/certificates/(int: certificate_id)

Retrieve metadata about the certificate (certificate_id)

Example request:

GET /api/v1/certificates/1 HTTP/1.1
Accept: application/vnd.api+json

Example response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": [{
        "type": "certificates",
        "attributes": {
            "not_after": "2018-03-26T23:42:09+00:00",
            "pem_certificate": "-----BEGIN CERTIFICATE----ABCDEF==\n-----END CERTIFICATE-----\n",
            "subject": "commandment.dev",
            "purpose": "mdm.cacert",
            "not_before": "2017-03-26T23:42:09+00:00"
        },
        "id": 1,
        "links": {
            "self": "/api/v1/certificates/1"
        }
    }],
    "meta": {"count": 1},
    "jsonapi": {"version": "1.0"}
}
Request Headers:
 
  • Accept – application/vnd.api+json
Response Headers:
 
Status Codes:

Other Endpoints

POST /api/v1/certificate_signing_requests

Create an object

GET /api/v1/certificate_signing_requests

Retrieve a collection of objects

POST /api/v1/devices/(int: device_id)/installed_applications
POST /api/v1/installed_applications

Create an object

GET /api/v1/devices/(int: device_id)/installed_applications
GET /api/v1/installed_applications

Retrieve a collection of objects

POST /api/v1/devices/(int: device_id)/installed_certificates
POST /api/v1/installed_certificates

Create an object

GET /api/v1/devices/(int: device_id)/installed_certificates
GET /api/v1/installed_certificates

Retrieve a collection of objects

POST /api/v1/devices/(int: device_id)/available_os_updates
POST /api/v1/available_os_updates

Create an object

GET /api/v1/devices/(int: device_id)/available_os_updates
GET /api/v1/available_os_updates

Retrieve a collection of objects

POST /api/v1/devices/(int: device_id)/installed_profiles
POST /api/v1/installed_profiles

Create an object

GET /api/v1/devices/(int: device_id)/installed_profiles
GET /api/v1/installed_profiles

Retrieve a collection of objects

POST /api/v1/push_certificates/

Create an object

GET /api/v1/push_certificates/

Retrieve a collection of objects

POST /api/v1/ssl_certificates/

Create an object

GET /api/v1/ssl_certificates/

Retrieve a collection of objects

POST /api/v1/ca_certificates/

Create an object

GET /api/v1/ca_certificates/

Retrieve a collection of objects

POST /api/v1/certificates/

Create an object

GET /api/v1/certificates/

Retrieve a collection of objects

POST /api/v1/applications

Create an object

GET /api/v1/applications

Retrieve a collection of objects

POST /api/v1/devices/(int: device_id)/commands
POST /api/v1/commands

Create an object

GET /api/v1/devices/(int: device_id)/commands
GET /api/v1/commands

Retrieve a collection of objects

POST /api/v1/device_groups/(int: device_group_id)/devices
POST /api/v1/devices

Create an object

GET /api/v1/device_groups/(int: device_group_id)/devices
GET /api/v1/devices

Retrieve a collection of objects

POST /api/v1/devices/(int: device_id)/tags
POST /api/v1/tags

Create an object

GET /api/v1/devices/(int: device_id)/tags
GET /api/v1/tags

Retrieve a collection of objects

POST /api/v1/devices/(int: device_id)/relationships/commands

Add / create relationship(s)

DELETE /api/v1/devices/(int: device_id)/relationships/commands

Delete relationship(s)

GET /api/v1/devices/(int: device_id)/relationships/commands

Get a relationship details

PATCH /api/v1/devices/(int: device_id)/relationships/commands

Update a relationship

POST /api/v1/devices/(int: device_id)/relationships/tags

Add / create relationship(s)

DELETE /api/v1/devices/(int: device_id)/relationships/tags

Delete relationship(s)

GET /api/v1/devices/(int: device_id)/relationships/tags

Get a relationship details

PATCH /api/v1/devices/(int: device_id)/relationships/tags

Update a relationship

POST /api/v1/tags/(int: tag_id)/relationships/devices

Add / create relationship(s)

DELETE /api/v1/tags/(int: tag_id)/relationships/devices

Delete relationship(s)

GET /api/v1/tags/(int: tag_id)/relationships/devices

Get a relationship details

PATCH /api/v1/tags/(int: tag_id)/relationships/devices

Update a relationship

DELETE /api/v1/certificate_signing_requests/(int: certificate_signing_request_id)

Delete an object

GET /api/v1/certificate_signing_requests/(int: certificate_signing_request_id)

Get object details

PATCH /api/v1/certificate_signing_requests/(int: certificate_signing_request_id)

Update an object

DELETE /api/v1/installed_applications/(int: installed_application_id)

Delete an object

GET /api/v1/installed_applications/(int: installed_application_id)

Get object details

PATCH /api/v1/installed_applications/(int: installed_application_id)

Update an object

DELETE /api/v1/installed_certificates/(int: installed_certificate_id)

Delete an object

GET /api/v1/installed_certificates/(int: installed_certificate_id)

Get object details

PATCH /api/v1/installed_certificates/(int: installed_certificate_id)

Update an object

DELETE /api/v1/available_os_updates/(int: available_os_update_id)

Delete an object

GET /api/v1/available_os_updates/(int: available_os_update_id)

Get object details

PATCH /api/v1/available_os_updates/(int: available_os_update_id)

Update an object

DELETE /api/v1/installed_profiles/(int: installed_profile_id)

Delete an object

GET /api/v1/installed_profiles/(int: installed_profile_id)

Get object details

PATCH /api/v1/installed_profiles/(int: installed_profile_id)

Update an object

DELETE /api/v1/rsa_private_keys/(int: private_key_id)

Delete an object

GET /api/v1/rsa_private_keys/(int: private_key_id)

Get object details

PATCH /api/v1/rsa_private_keys/(int: private_key_id)

Update an object

DELETE /api/v1/certificates/(int: certificate_id)

Delete an object

GET /api/v1/certificates/(int: certificate_id)

Get object details

PATCH /api/v1/certificates/(int: certificate_id)

Update an object

DELETE /api/v1/applications/(int: application_id)

Delete an object

GET /api/v1/applications/(int: application_id)

Get object details

PATCH /api/v1/applications/(int: application_id)

Update an object

DELETE /api/v1/commands/(int: command_id)

Delete an object

GET /api/v1/commands/(int: command_id)

Get object details

PATCH /api/v1/commands/(int: command_id)

Update an object

DELETE /api/v1/devices/(int: device_id)

Delete an object

GET /api/v1/devices/(int: device_id)

Get object details

PATCH /api/v1/devices/(int: device_id)

Update an object

DELETE /api/v1/tags/(int: tag_id)

Delete an object

GET /api/v1/tags/(int: tag_id)

Get object details

PATCH /api/v1/tags/(int: tag_id)

Update an object