The following OpenAPI 3.0.3 specification can be downloaded here

Local Actor API v2 2.0

Subscriptions

---

POST /{actorCommonName}/subscriptions

Input parameters

Parameter	In	Type	Default	Nullable	Description
actorCommonName	path	string		No

Request body

application/json

{
    "selector": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "selector": {
            "type": "string"
        }
    },
    "title": "SubscriptionRequest"
}

Response 200 OK

application/json

{
    "id": "string",
    "selector": "string",
    "status": "REQUESTED",
    "endpoints": [
        {
            "host": "string",
            "port": 0,
            "source": "string",
            "maxBandwidth": 0,
            "maxMessageRate": 0
        }
    ],
    "lastUpdatedTimestamp": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        },
        "selector": {
            "type": "string"
        },
        "status": {
            "type": "string",
            "enum": [
                "REQUESTED",
                "CREATED",
                "ILLEGAL",
                "NOT_VALID",
                "NO_OVERLAP",
                "RESUBSCRIBE"
            ]
        },
        "endpoints": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/SubscriptionEndpoint"
            }
        },
        "lastUpdatedTimestamp": {
            "type": "integer"
        }
    },
    "title": "Subscription"
}

---

GET /{actorCommonName}/subscriptions

Input parameters

Parameter	In	Type	Default	Nullable	Description
actorCommonName	path	string		No

Response 200 OK

application/json

[
    {
        "id": "string",
        "selector": "string",
        "status": "REQUESTED",
        "endpoints": [
            {
                "host": "string",
                "port": 0,
                "source": "string",
                "maxBandwidth": 0,
                "maxMessageRate": 0
            }
        ],
        "lastUpdatedTimestamp": 0
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/Subscription"
    }
}

---

GET /{actorCommonName}/subscriptions/{subscriptionId}

Input parameters

Parameter	In	Type	Default	Nullable	Description
actorCommonName	path	string		No
subscriptionId	path	string		No

Response 200 OK

application/json

{
    "id": "string",
    "selector": "string",
    "status": "REQUESTED",
    "endpoints": [
        {
            "host": "string",
            "port": 0,
            "source": "string",
            "maxBandwidth": 0,
            "maxMessageRate": 0
        }
    ],
    "lastUpdatedTimestamp": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        },
        "selector": {
            "type": "string"
        },
        "status": {
            "type": "string",
            "enum": [
                "REQUESTED",
                "CREATED",
                "ILLEGAL",
                "NOT_VALID",
                "NO_OVERLAP",
                "RESUBSCRIBE"
            ]
        },
        "endpoints": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/SubscriptionEndpoint"
            }
        },
        "lastUpdatedTimestamp": {
            "type": "integer"
        }
    },
    "title": "Subscription"
}

---

DELETE /{actorCommonName}/subscriptions/{subscriptionId}

Input parameters

Parameter	In	Type	Default	Nullable	Description
actorCommonName	path	string		No
subscriptionId	path	string		No

Response 204 No Content

---

GET /{actorCommonName}/subscriptions/capabilities

Input parameters

Parameter	In	Type	Default	Nullable	Description
actorCommonName	path	string		No
selector	query	string		No

Response 200 OK

application/json

[
    {
        "application": {
            "messageType": "string",
            "protocolVersion": "string",
            "publisherId": "string",
            "publicationId": "string",
            "originatingCountry": "string",
            "quadTree": [
                "string"
            ]
        },
        "metadata": {
            "shardCount": 0,
            "infoURL": "string",
            "redirectPolicy": "OPTIONAL",
            "maxBandwidth": 0,
            "maxMessageRate": 0,
            "repetitionInterval": 0
        }
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/Capability"
    }
}

Deliveries

---

POST /{actorCommonName}/deliveries

Input parameters

Parameter	In	Type	Default	Nullable	Description
actorCommonName	path	string		No

Request body

application/json

{
    "selector": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "selector": {
            "type": "string"
        }
    },
    "title": "DeliveryRequest"
}

Response 200 OK

application/json

{
    "id": "string",
    "selector": "string",
    "status": "REQUESTED",
    "endpoints": [
        {
            "host": "string",
            "port": 0,
            "target": "string",
            "selector": "string",
            "maxBandwidth": 0,
            "maxMessageRate": 0
        }
    ],
    "lastUpdatedTimestamp": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        },
        "selector": {
            "type": "string"
        },
        "status": {
            "type": "string",
            "enum": [
                "REQUESTED",
                "CREATED",
                "ILLEGAL",
                "NOT_VALID",
                "NO_OVERLAP"
            ]
        },
        "endpoints": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/DeliveryEndpoint"
            }
        },
        "lastUpdatedTimestamp": {
            "type": "integer"
        }
    },
    "title": "Delivery"
}

---

GET /{actorCommonName}/deliveries

Input parameters

Parameter	In	Type	Default	Nullable	Description
actorCommonName	path	string		No

Response 200 OK

application/json

[
    {
        "id": "string",
        "selector": "string",
        "status": "REQUESTED",
        "endpoints": [
            {
                "host": "string",
                "port": 0,
                "target": "string",
                "selector": "string",
                "maxBandwidth": 0,
                "maxMessageRate": 0
            }
        ],
        "lastUpdatedTimestamp": 0
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/Delivery"
    }
}

---

GET /{actorCommonName}/deliveries/{deliveryId}

Input parameters

Parameter	In	Type	Default	Nullable	Description
actorCommonName	path	string		No
deliveryId	path	string		No

Response 200 OK

application/json

{
    "id": "string",
    "selector": "string",
    "status": "REQUESTED",
    "endpoints": [
        {
            "host": "string",
            "port": 0,
            "target": "string",
            "selector": "string",
            "maxBandwidth": 0,
            "maxMessageRate": 0
        }
    ],
    "lastUpdatedTimestamp": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        },
        "selector": {
            "type": "string"
        },
        "status": {
            "type": "string",
            "enum": [
                "REQUESTED",
                "CREATED",
                "ILLEGAL",
                "NOT_VALID",
                "NO_OVERLAP"
            ]
        },
        "endpoints": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/DeliveryEndpoint"
            }
        },
        "lastUpdatedTimestamp": {
            "type": "integer"
        }
    },
    "title": "Delivery"
}

---

DELETE /{actorCommonName}/deliveries/{deliveryId}

Input parameters

Parameter	In	Type	Default	Nullable	Description
actorCommonName	path	string		No
deliveryId	path	string		No

Response 204 No Content

---

GET /{actorCommonName}/deliveries/capabilities

Input parameters

Parameter	In	Type	Default	Nullable	Description
actorCommonName	path	string		No
selector	query	string		No

Response 200 OK

application/json

[
    {
        "application": {
            "messageType": "string",
            "protocolVersion": "string",
            "publisherId": "string",
            "publicationId": "string",
            "originatingCountry": "string",
            "quadTree": [
                "string"
            ]
        },
        "metadata": {
            "shardCount": 0,
            "infoURL": "string",
            "redirectPolicy": "OPTIONAL",
            "maxBandwidth": 0,
            "maxMessageRate": 0,
            "repetitionInterval": 0
        }
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/Capability"
    }
}

Capabilities

---

POST /{actorCommonName}/capabilities

Input parameters

Parameter	In	Type	Default	Nullable	Description
actorCommonName	path	string		No

Request body

application/json

{
    "application": {
        "messageType": "string",
        "protocolVersion": "string",
        "publisherId": "string",
        "publicationId": "string",
        "originatingCountry": "string",
        "quadTree": [
            "string"
        ]
    },
    "metadata": {
        "shardCount": 0,
        "infoURL": "string",
        "redirectPolicy": "OPTIONAL",
        "maxBandwidth": 0,
        "maxMessageRate": 0,
        "repetitionInterval": 0
    }
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "application": {
            "type": "object",
            "properties": {
                "messageType": {
                    "type": "string"
                },
                "protocolVersion": {
                    "type": "string"
                },
                "publisherId": {
                    "type": "string"
                },
                "publicationId": {
                    "type": "string"
                },
                "originatingCountry": {
                    "type": "string"
                },
                "quadTree": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                }
            }
        },
        "metadata": {
            "type": "object",
            "properties": {
                "shardCount": {
                    "type": "integer",
                    "default": 1
                },
                "infoURL": {
                    "type": "string"
                },
                "redirectPolicy": {
                    "type": "string",
                    "enum": [
                        "OPTIONAL",
                        "MANDATORY",
                        "UNAVAILABLE"
                    ]
                },
                "maxBandwidth": {
                    "type": "integer"
                },
                "maxMessageRate": {
                    "type": "integer"
                },
                "repetitionInterval": {
                    "type": "integer"
                }
            }
        }
    },
    "title": "Capability"
}

Response 200 OK

application/json

Schema of the response body

{
    "allOf": [
        {
            "type": "object",
            "properties": {
                "id": {
                    "type": "string"
                }
            }
        },
        {
            "$ref": "#/components/schemas/Capability"
        }
    ],
    "title": "OnboardingCapability"
}

---

GET /{actorCommonName}/capabilities

Input parameters

Parameter	In	Type	Default	Nullable	Description
actorCommonName	path	string		No

Response 200 OK

application/json

[
    null
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/OnboardingCapability"
    }
}

---

GET /{actorCommonName}/capabilities/{capabilityId}

Input parameters

Parameter	In	Type	Default	Nullable	Description
actorCommonName	path	string		No
capabilityId	path	string		No

Response 200 OK

application/json

Schema of the response body

{
    "allOf": [
        {
            "type": "object",
            "properties": {
                "id": {
                    "type": "string"
                }
            }
        },
        {
            "$ref": "#/components/schemas/Capability"
        }
    ],
    "title": "OnboardingCapability"
}

---

DELETE /{actorCommonName}/capabilities/{capabilityId}

Input parameters

Parameter	In	Type	Default	Nullable	Description
actorCommonName	path	string		No
capabilityId	path	string		No

Response 204 No Content

Certificates

---

POST /{actorCommonName}/x509/csr

Input parameters

Parameter	In	Type	Default	Nullable	Description
actorCommonName	path	string		No

Request body

application/json

{
    "csr": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQ3ZUQ0NBYVVDQVFBd2VERWdNQjRHQ1NxR1NJYjNEUUVKQVJZUmJHVmhibVJsY2tCdU0zSmtMbXhwWm1VeApNekF4QmdOVkJBTU1LbkJwYkc5MGFXNTBaWEpqYUdGdVoyVXVaWFV1ZEd4bGVDNXpaUzV1TTNKa0xteHBabVV1CmRHVnpkREVTTUJBR0ExVUVDZ3dKVGpOeVpDQk1hV1psTVFzd0NRWURWUVFHRXdKT1REQ0NBU0l3RFFZSktvWkkKaHZjTkFRRUJCUUFEZ2dFUEFEQ0NBUW9DZ2dFQkFMT0FsZ2hVR1dBY0tCS1ZxYXZXQnZsUHZTaURvdVhNV01oZwp0eGZFQ1pWNDlsYWxINjZLTTRlRExDMCtqWjlBWmpaNGg4TEYyQS9tZENkeE9UK1hlc3N0YjViSjZiRVZxTUkxCkp3RG1ITVZUaHlYWVhialIvU1JkaTUzS0xhcENGcjMrWC8wQi9aZ1F5Y29FNzMySVJMN2NlOVprQ2tuWTRyUEwKVkhrTVFLZVZ6RVEraTlaSGNmNkNmbTVMY1FJU0RrODB3MndTelBXcjF1b3JnTFJuYXN2N1pCenAyWXVjTHlkdAovMHBBa3BKeUJnejRra1Ixck4yOE5IeUM0RXQxdzdzOHFjcVZSMDFsRWRxdUlmUjVjMHJMdzdIZFZzT0EwOHR4ClN3NndlcmpMQndYV3FrT2tuUVdCd2lRZ0FXQmtRVE9pZHZaZ3RQaVZFMkNoSGVDQzVDY0NBd0VBQWFBQU1BMEcKQ1NxR1NJYjNEUUVCQ3dVQUE0SUJBUUI0YnZOVG8vVjA3dlcrYnlGRFNoV1pOK05wR3hVbzVXV2N1Nzk1L2lLUgpjK2g5OXUvUnFWY1BPNXkvckJoTVovTUp6VEZZMko2Y3YyK0dZYkJqa1VhTm45MjE2RDhOQU1wRFR6bHEyVFR4CnROYWJ5eE5ubXJYVnZjUXhFZzRDdzlJN3ZXR0VvQzlCN1I1OGxiVGRDNG95M0VBc2J1dHJJT21PRGMvRWR1SnoKMnRSZ3pEeG9OVWRrWWREcFhyRkthTEczRXlTSjFsVEpuN3MzZEl6UCtkdElPOXBjVjJtMUZKQlpsanRWbmpUTgptM2h0UTZtN2JkbXBUTCtTdEEwTUtJZGFmWFE5R2xBS0cxdWNHNCs2RkR3RVhIZmJ4U2drQ3JyQzg0dWt5TGR1CjBJUWs1NUlqTjFnUy84TVZWN0cycm9uN01KSHBNeWFKaWhYMWNGRTd1TjhYCi0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo="
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "csr": {
            "type": "string",
            "example": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQ3ZUQ0NBYVVDQVFBd2VERWdNQjRHQ1NxR1NJYjNEUUVKQVJZUmJHVmhibVJsY2tCdU0zSmtMbXhwWm1VeApNekF4QmdOVkJBTU1LbkJwYkc5MGFXNTBaWEpqYUdGdVoyVXVaWFV1ZEd4bGVDNXpaUzV1TTNKa0xteHBabVV1CmRHVnpkREVTTUJBR0ExVUVDZ3dKVGpOeVpDQk1hV1psTVFzd0NRWURWUVFHRXdKT1REQ0NBU0l3RFFZSktvWkkKaHZjTkFRRUJCUUFEZ2dFUEFEQ0NBUW9DZ2dFQkFMT0FsZ2hVR1dBY0tCS1ZxYXZXQnZsUHZTaURvdVhNV01oZwp0eGZFQ1pWNDlsYWxINjZLTTRlRExDMCtqWjlBWmpaNGg4TEYyQS9tZENkeE9UK1hlc3N0YjViSjZiRVZxTUkxCkp3RG1ITVZUaHlYWVhialIvU1JkaTUzS0xhcENGcjMrWC8wQi9aZ1F5Y29FNzMySVJMN2NlOVprQ2tuWTRyUEwKVkhrTVFLZVZ6RVEraTlaSGNmNkNmbTVMY1FJU0RrODB3MndTelBXcjF1b3JnTFJuYXN2N1pCenAyWXVjTHlkdAovMHBBa3BKeUJnejRra1Ixck4yOE5IeUM0RXQxdzdzOHFjcVZSMDFsRWRxdUlmUjVjMHJMdzdIZFZzT0EwOHR4ClN3NndlcmpMQndYV3FrT2tuUVdCd2lRZ0FXQmtRVE9pZHZaZ3RQaVZFMkNoSGVDQzVDY0NBd0VBQWFBQU1BMEcKQ1NxR1NJYjNEUUVCQ3dVQUE0SUJBUUI0YnZOVG8vVjA3dlcrYnlGRFNoV1pOK05wR3hVbzVXV2N1Nzk1L2lLUgpjK2g5OXUvUnFWY1BPNXkvckJoTVovTUp6VEZZMko2Y3YyK0dZYkJqa1VhTm45MjE2RDhOQU1wRFR6bHEyVFR4CnROYWJ5eE5ubXJYVnZjUXhFZzRDdzlJN3ZXR0VvQzlCN1I1OGxiVGRDNG95M0VBc2J1dHJJT21PRGMvRWR1SnoKMnRSZ3pEeG9OVWRrWWREcFhyRkthTEczRXlTSjFsVEpuN3MzZEl6UCtkdElPOXBjVjJtMUZKQlpsanRWbmpUTgptM2h0UTZtN2JkbXBUTCtTdEEwTUtJZGFmWFE5R2xBS0cxdWNHNCs2RkR3RVhIZmJ4U2drQ3JyQzg0dWt5TGR1CjBJUWs1NUlqTjFnUy84TVZWN0cycm9uN01KSHBNeWFKaWhYMWNGRTd1TjhYCi0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo="
        }
    }
}

Response 200 OK

application/json

{
    "certificates": [
        "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUU0akNDQXNxZ0F3SUJBZ0lDRWowd0RRWUpLb1pJaHZjTkFRRU5CUUF3UnpFTE1Ba0dBMVVFQmhNQ1UwVXgKRXpBUkJnTlZCQW9NQ2s1dmNtUnBZeUJYWVhreEl6QWhCZ05WQkFNTUdtNTNNeTFwYm5SbGNtTm9ZVzVuWlMxagpZUzUwYkdWNExuTmxNQjRYRFRJeE1URXhPVEV4TURjME5Wb1hEVE15TURJeU5URXhNRGMwTlZvd2VERUxNQWtHCkExVUVCaE1DVGt3eEVqQVFCZ05WQkFvTUNVNHpjbVFnVEdsbVpURXpNREVHQTFVRUF3d3FjR2xzYjNScGJuUmwKY21Ob1lXNW5aUzVsZFM1MGJHVjRMbk5sTG00emNtUXViR2xtWlM1MFpYTjBNU0F3SGdZSktvWklodmNOQVFrQgpGaEZzWldGdVpHVnlRRzR6Y21RdWJHbG1aVENDQVNJd0RRWUpLb1pJaHZjTkFRRUJCUUFEZ2dFUEFEQ0NBUW9DCmdnRUJBTE9BbGdoVUdXQWNLQktWcWF2V0J2bFB2U2lEb3VYTVdNaGd0eGZFQ1pWNDlsYWxINjZLTTRlRExDMCsKalo5QVpqWjRoOExGMkEvbWRDZHhPVCtYZXNzdGI1Yko2YkVWcU1JMUp3RG1ITVZUaHlYWVhialIvU1JkaTUzSwpMYXBDRnIzK1gvMEIvWmdReWNvRTczMklSTDdjZTlaa0Nrblk0clBMVkhrTVFLZVZ6RVEraTlaSGNmNkNmbTVMCmNRSVNEazgwdzJ3U3pQV3IxdW9yZ0xSbmFzdjdaQnpwMll1Y0x5ZHQvMHBBa3BKeUJnejRra1Ixck4yOE5IeUMKNEV0MXc3czhxY3FWUjAxbEVkcXVJZlI1YzByTHc3SGRWc09BMDh0eFN3NndlcmpMQndYV3FrT2tuUVdCd2lRZwpBV0JrUVRPaWR2Wmd0UGlWRTJDaEhlQ0M1Q2NDQXdFQUFhT0JwakNCb3pBSkJnTlZIUk1FQWpBQU1CRUdDV0NHClNBR0crRUlCQVFRRUF3SUZvREF6QmdsZ2hrZ0JodmhDQVEwRUpoWWtUM0JsYmxOVFRDQkhaVzVsY21GMFpXUWcKUTJ4cFpXNTBJRU5sY25ScFptbGpZWFJsTUI4R0ExVWRJd1FZTUJhQUZFQWtPcjdwL1NPaUI1bTI5RElQMUZOKwpZMlYzTUE0R0ExVWREd0VCL3dRRUF3SUY0REFkQmdOVkhTVUVGakFVQmdnckJnRUZCUWNEQWdZSUt3WUJCUVVICkF3UXdEUVlKS29aSWh2Y05BUUVOQlFBRGdnSUJBQTAvTXRnOGlaR0t0Mzl0eHBnZWhMV2RSZkxnOVdUQWU5THkKMHgvK0k3RStwZW5mRGZnQW5tU0hVRG93eWo3OUlna1YxTGJETnBuMUEyZ01wTjA3QUwvY1pibUJ3RU14ZDc5cApTR3FjaVJsVlhYKzBhZGVXRDBDYWZlU0FBNE02eWlieldiYlAyREIzQ1BFOTNMTC8zYWN0YlNNTEhqOEFaeFRnCm1VN2lxVTRTd1QrR2hWR0czWFNRZWtZTTBXejJZZzluL2VRWUNDOHpQSzhMWFArbXNzWDVLaW5NMkR1a1IvY1IKblQ3K05LNzdZNzhicjlvUkJleGl3aURyb05UZU1DZFByQVVyRG05STlOQzlrbmZkOU8xTk4rSmlQZG9uNGZOdQpoV1VCWGU1WG8yZEhoNUJEVDNteWJ0MERyZ1hiVVVVQUNnUmdlcnFoa2dJQjA5MUIzWC9nYnZGbDl4SlUwUWwxCml5MUxhYUFaQWR4a2l2dmVmdVdtQnI2UW5sakZHbngxZ3JQcUtqNk5lY3N3ZWN2UjNhV0hTQXlOeWFENDB2MFQKRkRzZk9ZdFkya0t0LzNlQ0UvZk5oRWNLT2xuOVk5RkZJOE04YjVjYUwwS21nQjQ2bExQaHZrcUxrdUhTOXdNZwpGV3pUQlZtZXh4R1VCR2hJYVE3QW5FK0pFVUdtN3dVQWkxai9ZbUdrbG5MSFZTVXZ0Z283aDdJMkJnTjlwNSt4CnBrVkZkQ3hCdi8zTGcwdmRIeDQ3K1lRMCtYTGNhUjRyT0wvdDVReUNwNjFuN29OSFlOclFLUE5XdHZtVzZlbWwKVXQvdkZ6WlhrdysyVGN2TlFqeENBZTN4U0RGZHZMaE5ldzVFQjMvd05HZkVJSVZSZFNxblZOSmVqbEhIV0JCdwpVVzd5MkJuSAotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg=="
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "certificates": {
            "type": "array",
            "items": {
                "type": "string",
                "example": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUU0akNDQXNxZ0F3SUJBZ0lDRWowd0RRWUpLb1pJaHZjTkFRRU5CUUF3UnpFTE1Ba0dBMVVFQmhNQ1UwVXgKRXpBUkJnTlZCQW9NQ2s1dmNtUnBZeUJYWVhreEl6QWhCZ05WQkFNTUdtNTNNeTFwYm5SbGNtTm9ZVzVuWlMxagpZUzUwYkdWNExuTmxNQjRYRFRJeE1URXhPVEV4TURjME5Wb1hEVE15TURJeU5URXhNRGMwTlZvd2VERUxNQWtHCkExVUVCaE1DVGt3eEVqQVFCZ05WQkFvTUNVNHpjbVFnVEdsbVpURXpNREVHQTFVRUF3d3FjR2xzYjNScGJuUmwKY21Ob1lXNW5aUzVsZFM1MGJHVjRMbk5sTG00emNtUXViR2xtWlM1MFpYTjBNU0F3SGdZSktvWklodmNOQVFrQgpGaEZzWldGdVpHVnlRRzR6Y21RdWJHbG1aVENDQVNJd0RRWUpLb1pJaHZjTkFRRUJCUUFEZ2dFUEFEQ0NBUW9DCmdnRUJBTE9BbGdoVUdXQWNLQktWcWF2V0J2bFB2U2lEb3VYTVdNaGd0eGZFQ1pWNDlsYWxINjZLTTRlRExDMCsKalo5QVpqWjRoOExGMkEvbWRDZHhPVCtYZXNzdGI1Yko2YkVWcU1JMUp3RG1ITVZUaHlYWVhialIvU1JkaTUzSwpMYXBDRnIzK1gvMEIvWmdReWNvRTczMklSTDdjZTlaa0Nrblk0clBMVkhrTVFLZVZ6RVEraTlaSGNmNkNmbTVMCmNRSVNEazgwdzJ3U3pQV3IxdW9yZ0xSbmFzdjdaQnpwMll1Y0x5ZHQvMHBBa3BKeUJnejRra1Ixck4yOE5IeUMKNEV0MXc3czhxY3FWUjAxbEVkcXVJZlI1YzByTHc3SGRWc09BMDh0eFN3NndlcmpMQndYV3FrT2tuUVdCd2lRZwpBV0JrUVRPaWR2Wmd0UGlWRTJDaEhlQ0M1Q2NDQXdFQUFhT0JwakNCb3pBSkJnTlZIUk1FQWpBQU1CRUdDV0NHClNBR0crRUlCQVFRRUF3SUZvREF6QmdsZ2hrZ0JodmhDQVEwRUpoWWtUM0JsYmxOVFRDQkhaVzVsY21GMFpXUWcKUTJ4cFpXNTBJRU5sY25ScFptbGpZWFJsTUI4R0ExVWRJd1FZTUJhQUZFQWtPcjdwL1NPaUI1bTI5RElQMUZOKwpZMlYzTUE0R0ExVWREd0VCL3dRRUF3SUY0REFkQmdOVkhTVUVGakFVQmdnckJnRUZCUWNEQWdZSUt3WUJCUVVICkF3UXdEUVlKS29aSWh2Y05BUUVOQlFBRGdnSUJBQTAvTXRnOGlaR0t0Mzl0eHBnZWhMV2RSZkxnOVdUQWU5THkKMHgvK0k3RStwZW5mRGZnQW5tU0hVRG93eWo3OUlna1YxTGJETnBuMUEyZ01wTjA3QUwvY1pibUJ3RU14ZDc5cApTR3FjaVJsVlhYKzBhZGVXRDBDYWZlU0FBNE02eWlieldiYlAyREIzQ1BFOTNMTC8zYWN0YlNNTEhqOEFaeFRnCm1VN2lxVTRTd1QrR2hWR0czWFNRZWtZTTBXejJZZzluL2VRWUNDOHpQSzhMWFArbXNzWDVLaW5NMkR1a1IvY1IKblQ3K05LNzdZNzhicjlvUkJleGl3aURyb05UZU1DZFByQVVyRG05STlOQzlrbmZkOU8xTk4rSmlQZG9uNGZOdQpoV1VCWGU1WG8yZEhoNUJEVDNteWJ0MERyZ1hiVVVVQUNnUmdlcnFoa2dJQjA5MUIzWC9nYnZGbDl4SlUwUWwxCml5MUxhYUFaQWR4a2l2dmVmdVdtQnI2UW5sakZHbngxZ3JQcUtqNk5lY3N3ZWN2UjNhV0hTQXlOeWFENDB2MFQKRkRzZk9ZdFkya0t0LzNlQ0UvZk5oRWNLT2xuOVk5RkZJOE04YjVjYUwwS21nQjQ2bExQaHZrcUxrdUhTOXdNZwpGV3pUQlZtZXh4R1VCR2hJYVE3QW5FK0pFVUdtN3dVQWkxai9ZbUdrbG5MSFZTVXZ0Z283aDdJMkJnTjlwNSt4CnBrVkZkQ3hCdi8zTGcwdmRIeDQ3K1lRMCtYTGNhUjRyT0wvdDVReUNwNjFuN29OSFlOclFLUE5XdHZtVzZlbWwKVXQvdkZ6WlhrdysyVGN2TlFqeENBZTN4U0RGZHZMaE5ldzVFQjMvd05HZkVJSVZSZFNxblZOSmVqbEhIV0JCdwpVVzd5MkJuSAotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg=="
            }
        }
    }
}

---

Schemas

Capability

Name	Type
application	Properties: messageType, protocolVersion, publisherId, publicationId, originatingCountry, quadTree
metadata	Properties: shardCount, infoURL, redirectPolicy, maxBandwidth, maxMessageRate, repetitionInterval

CertificateSignRequest

Name	Type
csr	string

CertificateSignResponse

Name	Type
certificates	Array<string>

Delivery

Name	Type
endpoints	Array<DeliveryEndpoint>
id	string
lastUpdatedTimestamp	integer
selector	string
status	string

DeliveryEndpoint

Name	Type
host	string
maxBandwidth	integer
maxMessageRate	integer
port	integer
selector	string
target	string

DeliveryRequest

Name	Type
selector	string

OnboardingCapability

Type:

Subscription

Name	Type
endpoints	Array<SubscriptionEndpoint>
id	string
lastUpdatedTimestamp	integer
selector	string
status	string

SubscriptionEndpoint

Name	Type
host	string
maxBandwidth	integer
maxMessageRate	integer
port	integer
source	string

SubscriptionRequest

Name	Type
selector	string