GlobalSign Inventory API documentation version v1.0

HTTP status code 200

Returned on successful authentication

Body

Media type: application/json;charset=utf-8

Type: object

• access_token: required(string)

Example:

{
  "access_token": "eyJhbGciOiAiSFMyNTYiLCAidHlwIjogIkpXVCJ9.eyJ1c2VyX2lkIjogMX0.BSf1w1blYKcbxVlyOtUogUsozH2clY34xxYPd8lQIlQ"
}

HTTP status code 400

Request could not be parsed

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Bad Request"
}

HTTP status code 401

Returned on unsuccessful authentication

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 411

Request Content-Length is absent or 0

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Content-Length required"
}

HTTP status code 415

Request content type is not application/json;charset=utf-8

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Bad Content-Type"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 201

Certificate successfully uploaded

Headers

• Location: required(string)

  The URL of the newly uploaded certificate

  Example:

  {baseUri}/certificate/{certID}

• Content-Length: required(integer - default: 0)

  This response does not contain a body

HTTP status code 400

Request could not be parsed

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Bad Request"
}

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 409

A certificate issued by the same CA with the same serial number already exists

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

HTTP status code 411

Request Content-Length is absent or 0

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Content-Length required"
}

HTTP status code 415

Request content type is not application/json;charset=utf-8

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Bad Content-Type"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 429

Request rate exceeded the set limit

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Rate Limit Reached"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 200

Return a list of certificates

Headers

• Total-Count: required(integer)

  Total number of elements found

  Example:

  20

• Links: required(string)

  Links to previous/next/last page if available

  Example:

  </certificates?page=2>; rel="previous"; </certificates?page=4>; rel="next", </certificates?page=5>; rel="last"

Body

Media type: application/json;charset=utf-8

Type: array of certificate_info

Items: certificate_info

Example:

[
  {
    "id": 1,
    "serial_number": "A098890043958186465006748393764320813",
    "ca_id": 5,
    "certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
    "not_before": 1477958400,
    "not_after": 1577836800,
    "status": "REVOKED",
    "uploaded_at": 1555514914,
    "revoked_at": 1555615914,
    "revocation_reason": "keyCompromise"
  },
  {
    "id": 2,
    "serial_number": "B098890043958186465006748393764320813",
    "ca_id": 3,
    "certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
    "not_before": 1567958400,
    "not_after": 1578836800,
    "status": "ISSUED",
    "uploaded_at": 1555514914
  }
]

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 429

Request rate exceeded the set limit

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Rate Limit Reached"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 200

Certificate available for retrieval

Body

Media type: application/json;charset=utf-8

Type: object

• id: required(integer)
• serial_number: required(string)
• ca_id: required(integer)

  internal inventory id of the CA that issued the certificate

• certificate: required(string - pattern: -{5}BEGIN CERTIFICATE-{5}.+-{5}END CERTIFICATE-{5})

  The certificate is PEM encoded. The PEM encoding format (defined in RFC 1421) requires a line length of 64 characters, except for the last line which can be shorter. In JSON newlines are delimited with ASCII newline symbol "\n".

• not_before: required(integer)

  UTC UNIX timestamp the certificate is valid from

• not_after: required(integer)

  UTC UNIX timestamp after which the certificate is no longer valid

• status: required(one of ISSUED, REVOKED)
• uploaded_at: required(integer)

  UTC UNIX timestamp at which the certificate was uploaded

• revoked_at: (integer)

  UTC UNIX timestamp at which the certificate was revoked

• revocation_reason: (one of unspecified, keyCompromise, cACompromise, affiliationChanged, superseded, cessationOfOperation, certificateHold, removeFromCRL, privilegeWithdrawn, aACompromise)

  Revocation reason as per RFC 5280 section 5.3.1

Example:

{
  "id": 1,
  "serial_number": "A098890043958186465006748393764320813",
  "ca_id": 5,
  "certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
  "not_before": 1477958400,
  "not_after": 1577836800,
  "status": "REVOKED",
  "uploaded_at": 1555514914,
  "revoked_at": 1555615914,
  "revocation_reason": "keyCompromise"
}

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 404

Requested resource is not found

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Not found"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 429

Request rate exceeded the set limit

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Rate Limit Reached"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 200

Certificate succesfully revoked

Headers

• Content-Length: required(integer - default: 0)

  This response does not return a body

HTTP status code 204

Certificate is already revoked

Headers

• Content-Length: required(integer - default: 0)

  This response does not return a body

HTTP status code 400

Request could not be parsed

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Bad Request"
}

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 404

Requested resource is not found

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Not found"
}

HTTP status code 411

Request Content-Length is absent or 0

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Content-Length required"
}

HTTP status code 415

Request content type is not application/json;charset=utf-8

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Bad Content-Type"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 429

Request rate exceeded the set limit

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Rate Limit Reached"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}