OPopenziti
Enroll
Extend Enrollment

Extend the life of a currently enrolled router's certificates

Changed on

Allows a router to extend its certificates' expiration date by using its current and valid client certificate to submit a CSR. This CSR may be passed in using a new private key, thus allowing private key rotation or swapping.

After completion any new connections must be made with certificates returned from a 200 OK response. The previous client certificate is rendered invalid for use with the controller even if it has not expired.

This request must be made using the existing, valid, client certificate.

post/enroll/extend/router

Request

Request body

certCsrstring required
serverCertCsrstring required

Response

A response containing the edge routers new signed certificates (server chain, server cert, CAs).

Example response

{
  "data": {
    "controllers": [
      {
        "_links": {
          "key": {
            "comment": "comment",
            "href": "https://openapi-generator.tech",
            "method": "method"
          }
        },
        "createdAt": "2000-01-23T04:56:07.000+00:00",
        "id": "id",
        "tags": {},
        "updatedAt": "2000-01-23T04:56:07.000+00:00",
        "apiAddresses": null,
        "certPem": "certPem",
        "ctrlAddress": "ctrlAddress",
        "fingerprint": "fingerprint",
        "isOnline": true,
        "isPreferredLeader": true,
        "lastJoinedAt": "2000-01-23T04:56:07.000+00:00",
        "name": "name"
      },
      {
        "_links": {
          "key": {
            "comment": "comment",
            "href": "https://openapi-generator.tech",
            "method": "method"
          }
        },
        "createdAt": "2000-01-23T04:56:07.000+00:00",
        "id": "id",
        "tags": {},
        "updatedAt": "2000-01-23T04:56:07.000+00:00",
        "apiAddresses": null,
        "certPem": "certPem",
        "ctrlAddress": "ctrlAddress",
        "fingerprint": "fingerprint",
        "isOnline": true,
        "isPreferredLeader": true,
        "lastJoinedAt": "2000-01-23T04:56:07.000+00:00",
        "name": "name"
      }
    ],
    "ca": "ca",
    "cert": "cert",
    "serverCert": "serverCert"
  },
  "meta": {
    "apiEnrollmentVersion": "apiEnrollmentVersion",
    "apiVersion": "apiVersion",
    "filterableFields": [
      "filterableFields",
      "filterableFields"
    ],
    "pagination": {
      "limit": 0.8008281904610115,
      "offset": 6.027456183070403,
      "totalCount": 1.4658129805029452
    }
  }
}

Changes

  • f7b51eaafbbbRevision changes
    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added subschema #2 to the response property allOf list for the response status

  • 058711718149Revision changes
    • info

      added the non-success response with the status