{ "openapi":"3.0.0", "info":{ "version":"2026.04.14", "title":"REST API for Session Border Controller, Enterprise Session Border Controller, and Subscriber-Aware Load Balancer, Release 10.1.0", "description":"The Oracle Communications Session Border Controller (SBC) API lets clients administer and configure SBC objects.", "x-summary":"The Oracle Communications Session Border Controller (SBC) API lets clients administer and configure SBC objects." }, "servers":[ { "url":"https://{managementIp}", "description":"Target system", "variables":{ "managementIp":{ "description":"Resolvable hostname or IP address of the target system", "default":"0.0.0.0" } } } ], "tags":[ { "name":"Admin", "description":"APIs for administrative operations." }, { "name":"Authentication", "description":"API for authorization. In this release, the only operation supported is the request (or re-request) of an authorization token, which the client must supply in all subsequent requests." }, { "name":"Certificates", "description":"APIs related to certificate management. GET requests can be made by a REST client without the configuration lock. But a REST client must possess the configuration lock before making PUT requests either to generate a certificate signing request (CSR) or to import a certificate." }, { "name":"Configuration", "description":"APIs affecting configuration elements. GET requests can be made by a client without the configuration lock, but any configuration request that changes the system configuration in any way—including saving, restoring, or activating it, plus POST, PUT, and DELETE—requires the REST client to first possess the configuration lock. Acquiring and releasing the lock are themselves both considered configuration operations." }, { "name":"Configuration Management", "description":"APIs related to management of configuration and configuration files." }, { "name":"Statistics", "description":"APIs related to statistics, KPIs, and metrics." }, { "name":"System", "description":"System level APIs." }, { "name":"api", "description":"APIs to retrieve information about the REST API itself." } ], "paths":{ "/rest/api/supportedversions":{ "get":{ "summary":"Get supported REST API versions", "description":"Retrieve a list of the supported REST API versions for this software release.", "tags":[ "api" ], "responses":{ "200":{ "description":"OK - Requested data is returned in response body", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/SupportedVersionsResponse" } } } }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "404":{ "description":"This API must not contain a version number", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-api-supportedversions-get", "x-filename-id":"rest-api-supportedversions-get" } }, "/rest/{version}/admin/asyncstatus":{ "get":{ "summary":"Get the status of last asynchronous request", "description":"Returns the status of the most recently-issued request that required asynchronous processing - regardless of whether the same REST client issued the original asynchronous request, or even if the request was issued by a non-REST user. It is not possible for a REST client to get the status of any request except the most recently issued.", "tags":[ "Admin" ], "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" } ], "responses":{ "200":{ "description":"The system successfully returns the status of the last asynchronous request. The response body indicates the asynchronous operation being reported and the status of that operation. Any asynchronous request-specific additional information that may be useful to the client is supplied within the <additionalInfo> tag. The contents of <additionalInfo> are defined as part of the documentation of the asynchronous request itself.

In the case of an asynchronous request that failed, an error message containing information about the failure is present within the <data> section.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/AsyncStatusResponse" } } } }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "403":{ "$ref":"#/components/responses/403ForbiddenNotAdmin" }, "404":{ "description":"Unsupported versionId in URI.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-admin-asyncstatus-get", "x-filename-id":"rest-version-admin-asyncstatus-get" } }, "/rest/{version}/admin/switchover":{ "post":{ "summary":"Execute HA switchover", "description":"Executes an HA switchover to switch from the active server to the standby server.

For more information on high availability, see High Availability in the ACLI Configuration Guide.", "tags":[ "Admin" ], "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" } ], "responses":{ "204":{ "description":"HA switchover request received. The switchover operation can take up to five seconds after the SBC sends a response to the client." }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "403":{ "$ref":"#/components/responses/403ForbiddenNotAdmin" }, "404":{ "description":"Unsupported versionId in URI.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-admin-switchover-post", "x-filename-id":"rest-version-admin-switchover-post" } }, "/rest/{version}/admin/refresh/{task}":{ "post":{ "summary":"Refresh internal tasks", "description":"Refreshes either the Fraud Protection Engine (FPE) with the recently uploaded FPE file or the Local Routing Table (LRT) with the recently uploaded LRT file.

For more information, see Telephony Fraud Protection or Local Route Tables in the ACLI Configuration Guide.

This API is only available for SBC and ESBC.

", "tags":[ "Admin" ], "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" }, { "in":"path", "name":"task", "required":true, "description":"Specifies the internal task to execute a refresh on.", "schema":{ "type":"string", "enum":[ "fpe", "lrt" ] } }, { "in":"query", "name":"filename", "description":"File name to use for refresh action", "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"Successful refresh of the internal task data. There is no response body for a successful refresh." }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "403":{ "$ref":"#/components/responses/403ForbiddenNotAdmin" }, "404":{ "description":"Unsupported versionId in URI.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-admin-refresh-{task}-post", "x-filename-id":"rest-version-admin-refresh-task-post" } }, "/rest/{version}/admin/test/lrt":{ "get":{ "summary":"Show the next hop for a specific route", "description":"Get the next hop from the LRT for a specific user.", "tags":[ "Admin" ], "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" }, { "in":"query", "name":"lrtName", "required":true, "description":"Specifies the name of the local route table.", "schema":{ "type":"string" } }, { "in":"query", "name":"user", "required":true, "description":"Specifies the name of the user within the local route table.", "schema":{ "type":"string" } }, { "in":"query", "name":"offset", "description":"When requesting multiple instances of a configuration element type that supports paging and a subset of all configured element instances is desired, offset must be supplied and specifies, using a 1-based index, the first instance that is returned in the response.", "required":false, "schema":{ "type":"integer", "format":"int32", "minimum":1 } }, { "in":"query", "name":"maxElements", "description":"The maximum number of configuration element instances that is returned in a paged response. If there are not maxInstances element instances in the requested result set, then the response contains fewer instances than maxInstances. The maxElements range is between 1 and 100.", "required":false, "schema":{ "type":"integer", "format":"int32", "minimum":0 } } ], "responses":{ "200":{ "description":"Success." }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "403":{ "$ref":"#/components/responses/403ForbiddenNotAdmin" }, "404":{ "description":"Unsupported versionId in URI.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-admin-test-lrt-get", "x-filename-id":"rest-version-admin-test-lrt-get" } }, "/rest/{version}/admin/reboot":{ "post":{ "summary":"Reboot the system", "description":"Reboots the system. Before rebooting itself, the system sends an immediate response to the client, indicating the reboot request was received. To determine when the reboot has completed and the system is again able to respond to requests, the client can issue requests periodically until a request no longer times out.", "tags":[ "Admin" ], "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" } ], "responses":{ "202":{ "description":"Reboot request received; reboot begins within five seconds of the response being sent to the client", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/RebootResponse" } } } }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "403":{ "$ref":"#/components/responses/403ForbiddenNotAdmin" }, "404":{ "description":"Unsupported versionId in URI.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "500":{ "description":"System is unable to execute the reboot due to some internal failure.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-admin-reboot-post", "x-filename-id":"rest-version-admin-reboot-post" } }, "/rest/{version}/auth/token":{ "post":{ "summary":"Request an access token", "description":"Requests an access token by providing a valid credential string. The client creates the credential string by Base64-encoding username:password, where username is a user name the system recognizes, the colon is literal, and password is the current password associated with username. The client then supplies the encoded credentials in the Authorization header of the /rest/{version}/auth/token request, using the header value Basic <encoded credential string>.

Once the client has a valid token it must be supplied in the Authorization header of all subsequent requests, using the header value Bearer <token string>. Tokens have a limited lifetime of ten minutes, and the client must re-authenticate by issuing another /rest/{version}/auth/token request upon expiry of the current token.

A client may re-authenticate before its current token expires, if desired. This is useful if a client currently holds the configuration lock, and needs to keep ownership of the lock longer then the ten minutes an access token is valid, in order to complete lengthy configuration changes. In order to re-authenticate prior to the current access token expiring, the client must supply login credentials in the Authorization header, just like an initial access token request, but must also supply the current, unexpired access token in the body of the request, and set the Content-Type header to x-www-form-urlencoded.

While it exists, the configuration lock is tied to a token. If a REST client loses the token, the client will have to wait until the token expires before requesting the configuration lock.", "tags":[ "Authentication" ], "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBasicHeaderParam" }, { "in":"header", "name":"Content-Type", "description":"If the client is requesting a new access token prior to the expiration of its current, unexpired token, the current, unexpired token must be provided in the request body and the Content-Type header must be set to the value x-www-form-urlencoded.", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The authentication credentials are valid and an access token is returned to the client. The token must be used in the Authorization header of all subsequent REST requests.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/AuthenticationTokenResponse" } } } }, "400":{ "description":"The Authorization header is missing, is malformed, or does not contain a value that can be decoded into a username and password.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "404":{ "description":"Either 'Unsupported versionId in URI' or 'Version is not specified in the URI'.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-auth-token-post", "x-filename-id":"rest-version-auth-token-post" } }, "/rest/{version}/configuration/bootparams":{ "get":{ "summary":"Get the boot parameters", "description":"Retrieves the boot parameters.", "tags":[ "Configuration" ], "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" } ], "responses":{ "200":{ "description":"The boot parameters are returned as a series of name-value pairs in the data section of the response.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/BootparametersResponse" } } } }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "404":{ "description":"Unsupported versionId in URI.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-configuration-bootparams-get", "x-filename-id":"rest-version-configuration-bootparams-get" }, "put":{ "summary":"Update the boot parameters", "description":"Updates the boot parameters. The client making the PUT request must already possess the configuration lock or the request fails. The client should first retrieve the full set of current boot parameters using /configuration/bootparams GET, update the desired parameter(s), then issue the PUT request with the complete set of boot parameters in the request payload.", "tags":[ "Configuration" ], "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" } ], "requestBody":{ "description":"Contains the full set of boot parameters retrieved using /configuration/bootparams GET.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/BootparametersInRequest" } } } }, "responses":{ "200":{ "description":"Boot parameters successfully updated. The updated boot parameters are returned as a series of name-value pairs in the data section of the response.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/BootparametersResponse" } } } }, "400":{ "description":"One or more boot parameter names or values supplied by the client is not valid, or the request is malformed and cannot be processed.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "403":{ "$ref":"#/components/responses/403ForbiddenNotAdmin" }, "404":{ "description":"Unsupported versionId in URI.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "423":{ "$ref":"#/components/responses/423Locked" } }, "x-internal-id":"rest-{version}-configuration-bootparams-put", "x-filename-id":"rest-version-configuration-bootparams-put" } }, "/rest/{version}/configuration/certificates":{ "get":{ "summary":"Get certificate details", "description":"Retrieves the imported certificate (CA signed and self signed) details. This request works only for a certificate-record, for which a certificate was already imported. The query string must include the recordName attribute and the format attribute. The value of recordName is the certificate-record to get and the format attribute is used for deciding the display format of the certificate. The order of these attributes in the query string does not matter.", "tags":[ "Certificates" ], "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" }, { "in":"query", "name":"recordName", "description":"Name of the certificate-record", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"format", "description":"Format the certificate-record to be retrieved. Options are either 'detail' or 'pem'.", "required":true, "schema":{ "type":"string", "enum":[ "detail", "pem" ] } } ], "responses":{ "200":{ "description":"OK - Requested certificate data is returned in detail format or in PEM format in response body.", "content":{ "application/xml":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/CertificateGETResponseDetailFormat" }, { "$ref":"#/components/schemas/CertificateGETResponsePemFormat" } ] } } } }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "404":{ "description":"Unsupported version ID in URI or certificate specified with recordName key attribute is not found or requested format is not supported.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-configuration-certificates-get", "x-filename-id":"rest-version-configuration-certificates-get" } }, "/rest/{version}/configuration/certificates/generateRequest":{ "put":{ "summary":"Generates certificate signing request (CSR) for a certificate-record", "description":"This API allows the client to generate a certificate signing request in PKCS10 PEM format. The generated private key is stored in the certificate-record configuration element. The client making this request must already possess the configuration lock or the request fails. If one or more attributes or sub-elements in the request is syntactically invalid in any way, this request fails and the certificate-record configuration is left unmodified.", "tags":[ "Certificates" ], "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" }, { "in":"query", "name":"recordName", "description":"Name of the certificate-record.", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"reGenerate", "description":"Flag to indicate whether to regenerate CSR or not", "required":false, "schema":{ "type":"string", "default":false, "enum":[ true, false ] } } ], "responses":{ "200":{ "description":"OK - Certificate signing request is returned in data section of the response body.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenerateCertSigningRequestResponse" } } } }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "403":{ "$ref":"#/components/responses/403ForbiddenNotAdmin" }, "404":{ "description":"Certificate specified with recordName key attribute is not found", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "423":{ "$ref":"#/components/responses/423Locked" } }, "x-internal-id":"rest-{version}-configuration-certificates-generateRequest-put", "x-filename-id":"rest-version-configuration-certificates-generaterequest-put" } }, "/rest/{version}/configuration/certificates/import":{ "put":{ "summary":"Import a CA-signed certificate", "description":"This API allows a REST client to import a CA-signed certificate. X509 and PKCS7 format certificates are supported. The client making this request must already possess the configuration lock or the request fails. If one or more attributes or sub-elements in the request is syntactically invalid in any way, this request fails and the certificate will not be imported.

This API also allows you to update a expiring certificate. To do this, acquire a new certificate from your CA and paste it into the body of the PUT request. Include the overwrite element with a value of true. For example <overwrite>true</overwrite>. See Update the TLS Certificate.", "tags":[ "Certificates" ], "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" } ], "requestBody":{ "description":"Add certificate data and format of the certificate.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/ImportCertificateRequest" } } } }, "responses":{ "200":{ "description":"OK - certificate record name in request body is returned in response body", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/ImportCertificateResponse" } } } }, "204":{ "description":"No content - The certificate-record was updated.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/ImportCertificateResponse" } } } }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "404":{ "description":"Unsupported version ID in URI or unknown instance is requested in the URL. ", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "423":{ "$ref":"#/components/responses/423Locked" } }, "x-internal-id":"rest-{version}-configuration-certificates-import-put", "x-filename-id":"rest-version-configuration-certificates-import-put" } }, "/rest/{version}/configuration/configElements":{ "get":{ "summary":"Get one or more configuration element instances", "description":"Retrieves one or more instances of the specified configuration element type. If a single instance is requested:

If multiple instances are requested, omit all key attribute query parameters to get all configured instances of the specified element type, or supply the offset and maxElements query parameters to limit the response data to the desired subset, for those element types that support paging.

By default, the instance data returned in a GET response is from the edited configuration. If the client wishes to retrieve the current running configuration instance data, include the optional \"&running=true\" in the request query parameters.

", "tags":[ "Configuration" ], "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" }, { "in":"query", "name":"elementType", "description":"Indicates the configuration element type being retrieved.", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"name=value", "description":"Specifies the name and value for one key attribute of the elementType. For elementTypes having multiple key attributes, each one must be represented by \"&name=value\" in the query string. This query parameter is omitted entirely for singleton element types, which by definition have no key attributes, and when requesting more than one instance.", "required":false, "schema":{ "type":"string" } }, { "in":"query", "name":"offset", "description":"When requesting multiple instances of a configuration element type that supports paging and a subset of all configured element instances is desired, offset must be supplied and specifies, using a 1-based index, the first instance that is returned in the response.", "required":false, "schema":{ "type":"integer", "format":"int32", "minimum":1 } }, { "in":"query", "name":"maxElements", "description":"The maximum number of configuration element instances that is returned in a paged response. If there are not maxInstances element instances in the requested result set, then the response contains fewer instances than maxInstances.", "required":false, "schema":{ "type":"integer", "format":"int32", "minimum":0 } }, { "in":"query", "name":"running", "description":"When included with a value of true, the instance data returned in the response is from the running configuration. When omitted the instance data returned is from the edited configuration.", "required":false, "schema":{ "type":"string", "enum":[ "true" ] } } ], "responses":{ "200":{ "description":"The instance data for the requested configuration element(s) is returned in the data section of the response. If the client is requesting all instances of a specific type (paged or not) and the system configuration includes no instances, 200 OK is returned, and the section of the response body is empty.", "content":{ "application/xml":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/SingleElementInstanceResponse" }, { "$ref":"#/components/schemas/MultipleElementInstancesResponse" } ] } } } }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "404":{ "description":"Unsupported versionId in URI, or requested element type not supported, or element instance specified by key attribute(s) not found", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-configuration-configElements-get", "x-filename-id":"rest-version-configuration-configelements-get" }, "post":{ "summary":"Add a single configuration element instance", "description":"Adds a single instance of the specified configuration element type to the system configuration. The client making the POST request must already possess the configuration lock or the request fails. If the configuration element type is a singleton - meaning only one instance can exist in the system configuration - the instance must first be created using POST, supplying only the element type in the POST request. The instance can then be edited via a subsequent PUT request. For any element type that supports multiple instances, the key attribute(s) sent in the POST request must not duplicate the key attribute(s) for any already-configured instance. The client can supply as many non-key attributes and sub-elements in the POST request for an element type that supports multiple instances. If the client attempts to create a singleton element type that has already been created, or if the key attributes duplicate an existing instance, 409 Conflict is returned. If one or more attributes/sub-elements in the request is syntactically invalid in any way, the POST request fails and the system configuration is left unmodified.", "tags":[ "Configuration" ], "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" } ], "requestBody":{ "description":"The client must supply the element type in all POST requests. If the element type being created is a singleton, no other information is required in the request body. If the element type being created can have multiple instances, the key attribute(s) for the type must be provided using tags.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/SingleConfigElement" } } } }, "responses":{ "200":{ "description":"Successful creation of the requested instance. The complete configuration data (all supported attributes and sub-elements) are returned in the response body.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/SingleElementInstanceResponse" } } } }, "400":{ "description":"One or more attribute/sub-element values supplied by the client is not syntactically valid, or the request is malformed and cannot be processed.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "403":{ "$ref":"#/components/responses/403ForbiddenNotAdmin" }, "404":{ "description":"Unsupported versionId in URI, or requested element type not supported.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "409":{ "description":"Attempt to create an existing singleton element type, or the supplied key attribute values already exist for a configured element instance.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "423":{ "$ref":"#/components/responses/423Locked" } }, "x-internal-id":"rest-{version}-configuration-configElements-post", "x-filename-id":"rest-version-configuration-configelements-post" }, "put":{ "summary":"Update a single configuration element instance", "description":"Updates the specified configuration element instance in the system configuration. The client making the PUT request must already possess the configuration lock or the request fails. If the specified element instance is a singleton - meaning only one instance can exist in the system configuration - it must first have been created using POST. When editing any non-singleton element, the PUT request body must include the key attribute(s) that uniquely identify the instance being edited, as well as any attributes or sub-elements that are being changed. However, the client is free to send all of the element's attributes/sub-elements in the PUT request. Any attribute/sub-element in the request that is identical to the system configuration will be left unmodified in the system configuration. If one or more attributes/sub-elements in the request is syntactically invalid in any way, the PUT request fails and the system configuration is left unmodified.", "tags":[ "Configuration" ], "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" } ], "requestBody":{ "description":"When updating a singleton element type, the request body must contain the element type and only those attributes/sub-elements that are being modified. When updating a non-singleton element type, the request body must contain the element type, the key attribute(s) to uniquely identify the instance being updated, and the attribute(s)/sub-element(s) that are being modified. In either case, however (singleton or non-), the client may provide the entire set of element attributes/sub-elements, and the system will only update those that are different from the current system configuration (assuming all supplied values are valid).", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/SingleConfigElement" } } } }, "responses":{ "200":{ "description":"Successful update of the requested instance. The complete configuration data (all supported attributes and sub-elements) are returned in the response body.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/SingleElementInstanceResponse" } } } }, "400":{ "description":"The request is missing required information and cannot be processed, or one or more attribute or sub-element names or values supplied by the client is not valid, or the request is malformed and cannot be processed.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "403":{ "$ref":"#/components/responses/403ForbiddenNotAdmin" }, "404":{ "description":"Unsupported versionId in URI, or requested element type not supported, or element instance specified by key attribute(s) not found.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "423":{ "$ref":"#/components/responses/423Locked" } }, "x-internal-id":"rest-{version}-configuration-configElements-put", "x-filename-id":"rest-version-configuration-configelements-put" }, "delete":{ "summary":"Delete a single configuration element instance", "description":"Deletes the specified configuration element instance in the system configuration. The client making the DELETE request must already possess the configuration lock or the request fails. For configuration element types that are singletons, which have no key attributes, the only query parameter included in the URI is elementType. For element types that can have multiple instances, the query string must include \"&name=value\" for each key attribute, where name is a key attribute name and value is the associated value. The order of the key attributes in the query string does not matter. The key attributes for an element type are identified in the metadata (/configuration/elementTypes/metadata).", "tags":[ "Configuration" ], "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" }, { "in":"query", "name":"elementType", "description":"Indicates the configuration element type being deleted.", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"name=value", "description":"Specifies the name and value for one key attribute of the elementType. For elementTypes having multiple key attributes, each one must be represented by \"&name=value\" in the query string. This query parameter is omitted entirely for singleton element types, which by definition have no key attributes.", "required":false, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"Successful deletion of the requested instance. There is no response body for a successful delete." }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "403":{ "$ref":"#/components/responses/403ForbiddenNotAdmin" }, "404":{ "description":"Unsupported versionId in URI, or requested element type not supported, or element instance specified by key attribute(s) not found.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "423":{ "$ref":"#/components/responses/423Locked" } }, "x-internal-id":"rest-{version}-configuration-configElements-delete", "x-filename-id":"rest-version-configuration-configelements-delete" } }, "/rest/{version}/configuration/configReferences":{ "delete":{ "summary":"Delete a configuration element and all its references", "description":"Deletes the specified configuration element and all its references in the system configuration. The client making the DELETE request must already possess the configuration lock or the request fails. Currently, this operation can be performed only on realm-config. For configuration element types that are singletons, which have no key attributes, this operation is not supported. For element types that can have multiple instances, the query string must include \"&name=value\" for each key attribute, where name is a key attribute name and value is the associated value. The order of the key attributes in the query string does not matter. The key attributes for an element type are identified in the metadata (/configuration/elementTypes/metadata). This operation deletes a single configuration element instance and its references at a time.", "tags":[ "Configuration" ], "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" }, { "in":"query", "name":"elementType", "description":"Indicates the configuration element type being deleted. Currently, realm-config only supported.", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"name=value", "description":"Specifies the name and value for one key attribute of the elementType. For elementTypes having multiple key attributes, each one must be represented by \"&name=value\" in the query string.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"Successful deletion of the configuration element and all its references. There is no response body for a successful delete." }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "403":{ "$ref":"#/components/responses/403ForbiddenNotAdmin" }, "404":{ "description":"Unsupported versionId in URI, or requested element type not supported, or element instance specified by key attribute(s) not found.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "423":{ "$ref":"#/components/responses/423Locked" } }, "x-internal-id":"rest-{version}-configuration-configReferences-delete", "x-filename-id":"rest-version-configuration-configreferences-delete" } }, "/rest/{version}/configuration/elementTypes":{ "get":{ "summary":"Get a list of all supported configuration element types", "description":"Retrieves a list of all the configuration element types supported by the target system. The name string returned for each type is the string the client must use in all other REST requests where element type must be supplied. The platform and entitlements affect some of the configuration element types that are available, so the response from one system may not be identical to the response received from a different system.", "tags":[ "Configuration" ], "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" } ], "responses":{ "200":{ "description":"The name and description of each configuration element type supported by the target system is returned in the data section of the response. The string returned as the \"name\" value must be used by the client in all requests where element type must be supplied. Configuration element types that are singletons are indicated by the elementType attribute single=\"true\".", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/ElementTypesResponse" } } } }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "404":{ "description":"Unsupported versionId in URI.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-configuration-elementTypes-get", "x-filename-id":"rest-version-configuration-elementtypes-get" } }, "/rest/{version}/configuration/elementTypes/metadata":{ "get":{ "summary":"Get the metadata for a configuration element type", "description":"Retrieves the metadata (schema) for the specified configuration element type. The metadata enables the client to know the characteristics of each attribute/sub-element that comprises the element type, so the client can self-validate its instance data before submitting a POST or PUT request. Note that the values for certain metadata tags may vary based on the platform or entitlements of the target system, as certain attribute ranges depend on the platform. The metadata returned for a given element type by one system may not be identical to the metadata returned by a different system.", "tags":[ "Configuration" ], "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" }, { "in":"query", "name":"elementType", "description":"Specifies the configuration element type whose metadata is being requested.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The metadata for the requested configuration element type is returned in the data section of the response.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/SingleElementMetadataResponse" } } } }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "404":{ "description":"Unsupported versionId in URI, or requested element type not supported.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-configuration-elementTypes-metadata-get", "x-filename-id":"rest-version-configuration-elementtypes-metadata-get" } }, "/rest/{version}/configuration/elementTypes/template":{ "get":{ "summary":"Get a template instance for a configuration element or sub-element type", "description":"Retrieves a template instance of the specified configuration element or sub-element type. The template instance is a data structure containing all of the supported attributes, mandatory sub-elements, and any specified optional sub-elements for the requested element or sub-element, with default values for each attribute. Clients can request a template as a starting point for creating the data structure needed for a /configuration/configElements POST request body.

There are three ways to request a template:
  1. Top-level element and mandatory sub-elements only: if the query string only includes the elementType parameter, and the elementType value specifies a top-level configuration element, then the returned template includes all of that top-level element type's attributes plus any mandatory sub-elements - but no optional sub-elements.
  2. Optional sub-element only: if the query string only includes the elementType parameter, and the elementType value is a path to a sub-element (for example, sip-manipulation/header-rules - a forward slash-delimited list of the top-level element type and sub-element type(s)), then the returned template includes only the requested sub-element, plus any of its own sub-elements which are mandatory.
  3. Full template structure: if the query string includes the elementType parameter, whose value is a top-level element type, plus one or more instances of the subElement parameter, then the returned template includes all of the top-level element type's attributes, any mandatory sub-elements, and each optional sub-element named in a subElement parameter.
", "tags":[ "Configuration" ], "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" }, { "in":"query", "name":"elementType", "description":"Specifies the configuration element type for which a template instance is requested. When requesting templates for top-level configuration element types (with or without optional sub-elements), the value for this query parameter is just the top-level configuration element type identifier (e.g., \"phy-interface\"). For optional sub-elements, the value is the hierarchical path to the desired sub-element, beginning with the top-level element itself (e.g., \"network-interface/bfd-config/bfd-session\").", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"subElement", "description":"When requesting the full template structure for a top-level element type that has optional sub-elements, there should be one subElement parameter for each optional sub-element the client wants included in the returned template. The value for each subElement parameter is the hierarchical path to the desired sub-element, _not_ including the top-level element itself, which is named in the elementType parameter (e.g., \"bfd-config/bfd-session\", under network-interface). The subElement parameter is included only when requesting a template for a top-level element plus one or more of its optional sub-elements.", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The template instance for the requested configuration element type is returned in the data section of the response.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/TemplateResponse" } } } }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "404":{ "description":"Unsupported versionId in URI, or requested element type not supported.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-configuration-elementTypes-template-get", "x-filename-id":"rest-version-configuration-elementtypes-template-get" } }, "/rest/{version}/configuration/lock":{ "post":{ "summary":"Lock the configuration", "description":"Before a REST client can make any configuration changes, the client must first acquire the configuration lock, which is the exclusive right to modify the configuration. If no other user or session is currently modifying the system configuration, 204 No Content is returned and the client can begin issuing configuration-modifying requests. If another user or session already owns the configuration lock, 423 Locked is returned.

While it exists, the configuration lock is tied to a token. If a REST client loses the token, the client will have to wait until the token expires before requesting the configuration lock.", "tags":[ "Configuration" ], "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" } ], "responses":{ "204":{ "description":"Client has successfully acquired the configuration lock and can begin making configuration changes." }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "403":{ "$ref":"#/components/responses/403ForbiddenNotAdmin" }, "404":{ "description":"Unsupported versionId in URI.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "423":{ "description":"Client did not acquire the configuration lock; another client/user already owns the lock.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-configuration-lock-post", "x-filename-id":"rest-version-configuration-lock-post" } }, "/rest/{version}/configuration/unlock":{ "post":{ "summary":"Unlock the configuration", "description":"Releases the configuration lock previously acquired by the client via /configuration/lock POST. If the client does not own the configuration lock and attempts to release it, 423 Locked is returned.

While it exists, the configuration lock is tied to a token. If a REST client loses the token, the client will have to wait until the token expires before requesting the configuration lock.", "tags":[ "Configuration" ], "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" } ], "responses":{ "204":{ "description":"Client has successfully released the configuration lock." }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "403":{ "$ref":"#/components/responses/403ForbiddenNotAdmin" }, "404":{ "description":"Unsupported versionId in URI.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "423":{ "$ref":"#/components/responses/423Locked" } }, "x-internal-id":"rest-{version}-configuration-unlock-post", "x-filename-id":"rest-version-configuration-unlock-post" } }, "/rest/{version}/configuration/management":{ "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" } ], "post":{ "summary":"Back up or activate a configuration", "description":"Executes configuration management action to either back up a configuration to the specified filename in the /code/bkups directory, or to activate the saved configuration. The client making the request must already possess the configuration lock or the request fail. This is an asynchronous request, that can take long enough the client must poll the system for the final result. If the request is received successfully, the immediate response to the client (202) simply indicates that the request was received and is being processed. The links section of the response includes the REST resource the client should use to poll for the final result.", "tags":[ "Configuration Management" ], "parameters":[ { "in":"query", "name":"action", "description":"Specifies which action to take with the configuration. Action can be to back up a configuration to a file from a particular configuration source, or activate the saved configuration.
Available values: backup, activate", "required":true, "schema":{ "type":"string", "enum":[ "backup", "activate" ] } }, { "in":"query", "name":"backupSource", "description":"Only valid when action is \"backup\". Specifies the source of the configuration to be backed up. When the action is \"backup\", both the \"backupSource\" parameter and \"filename\" parameter are required. The backupSource will specify which configuration is written to the backup file.
Available values: running, saved, editing", "required":false, "schema":{ "type":"string", "enum":[ "running", "saved", "editing" ] } }, { "in":"query", "name":"filename", "description":"Only valid when action is \"backup\". Specifies the file name of the backup file. When the action is \"backup\", both the \"backupSource\" parameter and \"filename\" parameter are required. The filename parameter must be included and specify a valid backup filename that is not already present in the file system in the /code/bkups directory. Specifying an already existing filename will result in a failure.", "required":false, "schema":{ "type":"string" } } ], "responses":{ "202":{ "description":"The configuration management request was received successfully and is being processed.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/ImmediateAynchronousResponse" } } } }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "403":{ "$ref":"#/components/responses/403ForbiddenNotAdmin" }, "404":{ "description":"Resource not found", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "423":{ "$ref":"#/components/responses/423Locked" } }, "x-internal-id":"rest-{version}-configuration-management-post", "x-filename-id":"rest-version-configuration-management-post" }, "put":{ "summary":"Save, verify or restore a configuration", "description":"Executes configuration management action to either save, verify or restore a configuration. A restore can be executed from different sources, including a specified file in the /code/bkups directory. The client making the request must already possess the configuration lock or the request fail. This is an asynchronous request, that can take long enough the client must poll the system for the final result. If the request is received successfully, the immediate response to the client (202) simply indicates that the request was received and is being processed. The links section of the response includes the REST resource the client should use to poll for the final result.", "tags":[ "Configuration Management" ], "parameters":[ { "in":"query", "name":"action", "description":"Configuration management action.
Available values: save, verify, restore", "required":true, "schema":{ "type":"string", "enum":[ "save", "verify", "restore" ] } }, { "in":"query", "name":"restoreSource", "description":"Only valid when action is \"restore\". Specifies the source of the configuration to be used for the restore.
Available values: running, saved, backupFile", "required":false, "schema":{ "type":"string", "enum":[ "running", "saved", "backupFile" ] } }, { "in":"query", "name":"filename", "description":"When the restoreSource parameter is \"backupFile\", this parameter must specify a valid backup file located in the /code/bkups directory. The value should be the filename only; specifying a path in the filename results in an error.", "required":false, "schema":{ "type":"string" } } ], "responses":{ "202":{ "description":"The configuration management request was received successfully and is being processed.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/ImmediateAynchronousResponse" } } } }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "403":{ "$ref":"#/components/responses/403ForbiddenNotAdmin" }, "404":{ "description":"Resource not found", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "423":{ "$ref":"#/components/responses/423Locked" } }, "x-internal-id":"rest-{version}-configuration-management-put", "x-filename-id":"rest-version-configuration-management-put" }, "delete":{ "summary":"Delete current configuration", "description":"Deletes the current configuration located in the /code/data and /code/config directories from the system's flash memory.", "tags":[ "Configuration Management" ], "parameters":[ { "in":"query", "name":"cached", "description":"Optional parameter to delete the cached configuration.
Available values: true, false", "required":false, "schema":{ "type":"boolean", "enum":[ true, false ] } } ], "responses":{ "204":{ "description":"Successful deletion of the requested instance. There is no response body for a successful delete." }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "403":{ "$ref":"#/components/responses/403ForbiddenNotAdmin" }, "404":{ "description":"Resource not found", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "423":{ "$ref":"#/components/responses/423Locked" } }, "x-internal-id":"rest-{version}-configuration-management-delete", "x-filename-id":"rest-version-configuration-management-delete" } }, "/rest/{version}/configuration/management/files":{ "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" } ], "get":{ "summary":"Get list of saved backup configuration files", "description":"Retrieves the list of all saved backup configuration files in the standard backup file directory (/code/bkups) in the file system.

For more information, see Configuration Overview in the Maintenance and Troubleshooting Guide.", "tags":[ "Configuration Management" ], "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" } ], "responses":{ "200":{ "description":"OK - Requested data is returned in response body" }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "404":{ "description":"Resource not found", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-configuration-management-files-get", "x-filename-id":"rest-version-configuration-management-files-get" }, "delete":{ "summary":"Delete saved backup configuration files", "description":"Deletes a saved backup configuration file from the standard backup file directory (/code/bkups) in the file system.

For more information, see Deleting Configurations in the Maintenance and Troubleshooting Guide.", "tags":[ "Configuration Management" ], "parameters":[ { "in":"query", "name":"filename", "description":"Specifies the backup file to delete. This parameter must specify a valid backup file located in the /code/bkups directory. The value should be the filename only; specifying a path in the filename results in an error.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"Successful deletion of the requested instance. There is no response body for a successful delete." }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "403":{ "$ref":"#/components/responses/403ForbiddenNotAdmin" }, "404":{ "description":"File not found", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "423":{ "$ref":"#/components/responses/423Locked" } }, "x-internal-id":"rest-{version}-configuration-management-files-delete", "x-filename-id":"rest-version-configuration-management-files-delete" } }, "/rest/{version}/configuration/versions":{ "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" } ], "get":{ "summary":"Get current and running configuration versions", "description":"Retrieves the version numbers of the current and running configuration. This integer value is incremented by one for each new configuration version.", "tags":[ "Configuration Management" ], "responses":{ "200":{ "description":"OK - Requested data is returned in response body", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/ConfigurationVersionsResponse" } } } }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "404":{ "description":"Resource not found", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-configuration-versions-get", "x-filename-id":"rest-version-configuration-versions-get" } }, "/rest/{version}/statistics/collections":{ "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" } ], "get":{ "summary":"Get current HDR collections status", "description":"Retrieves the current status of all Historical Data Records (HDR) collections and push receivers.

This API is only available for SBC and ESBC.

", "tags":[ "Statistics" ], "responses":{ "200":{ "description":"OK - Requested data is returned in response body", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/StatisticsCollectionsResponse" } } } }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "404":{ "description":"Resource not found", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-statistics-collections-get", "x-filename-id":"rest-version-statistics-collections-get" }, "put":{ "summary":"Start, stop or restart HDR collection", "description":"Executes Historical Data Records (HDR) collection command to start, stop or restart collection on one or all collection groups.

This API is only available for SBC and ESBC.

", "tags":[ "Statistics" ], "parameters":[ { "in":"query", "name":"action", "description":"Collection action to take on data collections.
Available values: start, stop, restart", "schema":{ "type":"string", "enum":[ "start", "stop", "restart" ] }, "required":true }, { "in":"query", "name":"collectionObject", "description":"Optional parameter to specify the collection group. This parameter is only valid for the \"start\" and \"stop\" collection actions. If this parameter is not specified, action is taken on all collection groups. The \"restart\" action is always taken on all collection groups.", "schema":{ "type":"string" }, "required":false } ], "responses":{ "200":{ "description":"OK - Request successful", "content":{ "application/xml":{ "schema":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "type":"object", "xml":{ "name":"data" } }, "messages":{ "type":"object", "properties":{ "message":{ "type":"string", "enum":[ "Collection process started", "Collection process stopped", "Collection process restarted", "Collection process purged" ], "example":"Collection process started" } } }, "links":{ "type":"object" } } } } } }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "403":{ "$ref":"#/components/responses/403ForbiddenNotAdmin" }, "404":{ "description":"Resource not found", "content":{ "application/xml":{ "schema":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "type":"object" }, "messages":{ "type":"object", "properties":{ "errorMessage":{ "type":"string", "example":"Collection action is invalid" } } }, "links":{ "type":"object" } } } } } } }, "x-internal-id":"rest-{version}-statistics-collections-put", "x-filename-id":"rest-version-statistics-collections-put" }, "delete":{ "summary":"Purge collected HDR files", "description":"Executes Historical Data Records collection command to purge all HDR files. This operation deletes all data files but does not stop HDR collection.

This API is only available for SBC and ESBC.

", "tags":[ "Statistics" ], "responses":{ "204":{ "description":"Successful deletion of the requested instance. There is no response body for a successful delete." }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "403":{ "$ref":"#/components/responses/403ForbiddenNotAdmin" }, "404":{ "description":"Resource not found", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-statistics-collections-delete", "x-filename-id":"rest-version-statistics-collections-delete" } }, "/rest/{version}/statistics/kpis":{ "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" }, { "in":"query", "name":"type", "required":true, "schema":{ "type":"string" }, "description":"This parameter specifies the KPI \"type\" to be retrieved. The KPI \"type\" is a set of related KPIs. Specifying this parameter will return all of the KPI data values of that particular \"type\". Use the parameter with a valid KPI type string.
Note - The valid KPI types can be discovered using the KPI discovery API (/statistics/kpiTypes)." } ], "get":{ "summary":"Get KPI data", "description":"This API retrieves KPI data. Using the hypermedia links returned in the discovery API (endpoint /statistics/kpiTypes), clients can retrieve the KPI data for a particular KPI \"type\". This will return all the KPI data values of the specified KPI type.", "tags":[ "Statistics" ], "responses":{ "200":{ "$ref":"#/components/responses/200KpiData1" }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "404":{ "description":"Resource not found", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-statistics-kpis-get", "x-filename-id":"rest-version-statistics-kpis-get" } }, "/rest/{version}/statistics/kpiTypes":{ "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" }, { "in":"query", "name":"type", "schema":{ "type":"string" }, "description":"This parameter specifies the KPI metadata \"type\" to be retrieved. The KPI \"type\" is a set of related KPIs. Specifying this parameter will return the KPI metadata response, which contains the KPI metadata (schema) for each of the KPI data values of associated with that KPI type. Use the \"type\" parameter with a valid KPI type string.
Note - The valid KPI types can be discovered using the KPI discovery API, which is this API without the \"type\" parameter." } ], "get":{ "summary":"Discover available KPI types or get the KPI schema for a type.", "description":"This API provides multiple purposes.

  1. KPI discovery -- This API can discover the list of available KPI \"types\" on the system and the names of the KPIs associated with that type. This discovery API uses the REST HATEOAS technique to return a list of hypermedia (hyperlinks and data) of available KPI types which can be invoked in subsequent REST requests. Through discovery, clients can learn the URL and method of the available resource endpoints that can be invoked. These are returned in the <links> section of the response, as <link> elements. Only KPIs supported via REST can be discovered with this API.

    Therefore, to retrieve the KPI discovery response, use the API without the \"type\" parameter.

  2. KPI metadata -- This API can retrieve the KPI metadata (schema). Using the hypermedia links returned in the discovery API (described above), clients can invoke the specific endpoint to retrieve the KPI metadata for a particular KPI \"type\". This will return the schema for each of the KPI data values associated with that KPI type.

    Therefore, to retrieve the KPI metadata (schema) response, use the API with the \"type\" parameter.

", "tags":[ "Statistics" ], "responses":{ "200":{ "description":"Successful for KPI metadata or KPI discovery.", "content":{ "application/xml":{ "schema":{ "oneOf":[ { "$ref":"#/components/responses/200KpiMetadata" }, { "$ref":"#/components/responses/200KpiDiscovery1" } ] } } } }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "404":{ "description":"Resource not found", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-statistics-kpiTypes-get", "x-filename-id":"rest-version-statistics-kpitypes-get" } }, "/rest/{version}/system/features":{ "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" } ], "get":{ "summary":"Get features, licenses and product information", "description":"Retrieves the list of enabled features, entitlements (provisioned and licensed) information, added licenses, and product type for this instance of software and hardware combination. The currently enabled features are based on added licenses.", "parameters":[ { "in":"query", "name":"accessFlags", "description":"In addition to feature information, also retrieve platform access flags information. Platform access flag information is data that is internal to the product and not required by customers.
Available values: true, false", "required":false, "schema":{ "type":"boolean", "enum":[ true, false ] } } ], "tags":[ "System" ], "responses":{ "200":{ "description":"OK - Requested data is returned in response body" }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "404":{ "description":"Resource not found", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-system-features-get", "x-filename-id":"rest-version-system-features-get" }, "post":{ "summary":"Add a license", "description":"Adds a license to the configuration using a key obtained from your service representative. The client making the POST request must already possess the configuration lock or the request fails. ", "tags":[ "System" ], "responses":{ "200":{ "description":"OK - Requested successful" }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "403":{ "$ref":"#/components/responses/403ForbiddenNotAdmin" }, "404":{ "description":"Resource not found", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "423":{ "$ref":"#/components/responses/423Locked" } }, "x-internal-id":"rest-{version}-system-features-post", "x-filename-id":"rest-version-system-features-post" }, "put":{ "summary":"Set up product type or entitlements", "description":"This API assigns a product type to this instance of software and hardware combination. This API is also used to set up entitlements for Provisioned Entitlements and Keyed (Licensed) Entitlements. This is used to self configure entitlements for the product which was set up. You can enable entitlements or provision capacity based entitlements. The client making the POST request must already possess the configuration lock or the request fails. ", "tags":[ "System" ], "responses":{ "200":{ "description":"OK - Request successful" }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "403":{ "$ref":"#/components/responses/403ForbiddenNotAdmin" }, "404":{ "description":"Resource not found", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "423":{ "$ref":"#/components/responses/423Locked" } }, "x-internal-id":"rest-{version}-system-features-put", "x-filename-id":"rest-version-system-features-put" }, "delete":{ "summary":"Delete a license", "description":"Deletes a license by feature. This is done based on configured license features.", "tags":[ "System" ], "responses":{ "204":{ "description":"Successful deletion of the requested instance. There is no response body for a successful delete." }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "403":{ "$ref":"#/components/responses/403ForbiddenNotAdmin" }, "404":{ "description":"Resource not found", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "423":{ "$ref":"#/components/responses/423Locked" } }, "x-internal-id":"rest-{version}-system-features-delete", "x-filename-id":"rest-version-system-features-delete" } }, "/rest/{version}/system/hardware":{ "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" } ], "get":{ "summary":"Get hardware entity information", "description":"Retrieves various hardware entity information such as chassis, CPU model, main board, network ports, power supplies, fan units, and other hardware-related information. Only supported on hardware SBCs, not virtual SBCs.", "tags":[ "System" ], "responses":{ "200":{ "description":"OK - Requested data is returned in response body", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/SystemHardwareResponse" } } } }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "404":{ "description":"Resource not found", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-system-hardware-get", "x-filename-id":"rest-version-system-hardware-get" } }, "/rest/{version}/system/information":{ "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" } ], "get":{ "summary":"Get system information", "description":"Retrieves various system information such as product name, build version, system uptime, serial number and other system-related information.", "tags":[ "System" ], "responses":{ "200":{ "description":"OK - Requested data is returned in response body", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/SystemInformationResponse" } } } }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "404":{ "description":"Resource not found", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-system-information-get", "x-filename-id":"rest-version-system-information-get" } }, "/rest/{version}/system/status":{ "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" } ], "get":{ "summary":"Get system status information", "description":"Retrieves the system uptime, system health, and HA/redundancy information (if configured as an HA system). ", "tags":[ "System" ], "responses":{ "200":{ "description":"OK - Requested data is returned in response body", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/SystemStatusResponse" } } } }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "404":{ "description":"Resource not found", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-system-status-get", "x-filename-id":"rest-version-system-status-get" } }, "/rest/{version}/system/storage":{ "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" } ], "get":{ "summary":"Get file system storage space information", "description":"Retrieves the remaining and used amount of space in the boot directory, code, and ramdrv devices.", "parameters":[ { "in":"query", "name":"volume", "description":"The file system volume", "required":false, "schema":{ "type":"string" } } ], "tags":[ "System" ], "responses":{ "200":{ "description":"OK - Requested data is returned in response body", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/SystemStorageResponse" } } } }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "404":{ "description":"Resource not found", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/SystemStorageErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-system-storage-get", "x-filename-id":"rest-version-system-storage-get" } }, "/rest/{version}/system/version":{ "parameters":[ { "$ref":"#/components/parameters/ApiVersionPathParam" }, { "$ref":"#/components/parameters/AuthorizationBearerHeaderParam" } ], "get":{ "summary":"Get system version information", "description":"Retrieves the current system software version. This includes product name, build version, build date, and other relevant information.", "tags":[ "System" ], "responses":{ "200":{ "description":"OK - Requested data is returned in response body", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/SystemVersionResponse" } } } }, "400":{ "$ref":"#/components/responses/400BadRequest" }, "401":{ "$ref":"#/components/responses/401Unauthorized" }, "404":{ "description":"Resource not found", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } } }, "x-internal-id":"rest-{version}-system-version-get", "x-filename-id":"rest-version-system-version-get" } } }, "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] } ], "components":{ "securitySchemes":{ "BasicAuth":{ "type":"http", "scheme":"basic" }, "BearerAuth":{ "type":"http", "scheme":"bearer" } }, "parameters":{ "AuthorizationBasicHeaderParam":{ "in":"header", "name":"Authorization", "description":"The value in the Authorization header must be the string \"Basic {encoded credential string}\", where {encoded credential string} is the Base64-encoding of \"username:password\".", "required":true, "schema":{ "type":"string" } }, "AuthorizationBearerHeaderParam":{ "in":"header", "name":"Authorization", "description":"The value in the Authorization header must be the string \"Bearer {access token}\", where {access token} is a valid, unexpired token received in response to a prior /rest/{version}/auth/token request.", "required":true, "schema":{ "type":"string" } }, "ApiVersionPathParam":{ "in":"path", "name":"version", "description":"REST API version string.
Available values: v1.2", "schema":{ "type":"string", "enum":[ "v1.2" ] }, "required":true } }, "responses":{ "400BadRequest":{ "description":"The request is malformed in some way or is missing required information and therefore cannot be processed.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "401Unauthorized":{ "description":"Unauthorized - Request lacks valid authentication credentials.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "403ForbiddenNotAdmin":{ "description":"This request requires the client credentials to have administrator privileges.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "423Locked":{ "description":"The request requires the configuration lock and failed because the client does not currently own the lock. If another client or user currently owns the configuration lock, the error message is \"Resource locked by another user\". If no client or user owns the configuration lock, the error message is \"User does not have the lock\".", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenericErrorsResponse" } } } }, "200KpiData1":{ "description":"KPI Data response - This is the response model when retrieving KPI data.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/StatisticsKpisDataResponse1" } } } }, "200KpiDiscovery1":{ "description":"This is the response model when the API is used to discover the list of available KPI types. The API is used without the \"type\" parameter to get this response.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/StatisticsKpisDiscoveryResponse1" } } } }, "200KpiMetadata":{ "description":"This is the response model when the API is used to retrieve the KPI metadata (schema). The API is used with the \"type\" parameter to get this response.", "content":{ "application/xml":{ "schema":{ "$ref":"#/components/schemas/StatisticsKpisMetadataResponse" } } } } }, "schemas":{ "CertificateSubjectIssuer":{ "type":"object", "required":[ "country", "state", "locality", "organization", "organizationUnitName", "commonName", "emailAddress" ], "properties":{ "country":{ "type":"string" }, "state":{ "type":"string" }, "locality":{ "type":"string" }, "organization":{ "type":"string" }, "organizationUnitName":{ "type":"string" }, "commonName":{ "type":"string" }, "emailAddress":{ "type":"string" } } }, "CertificateGETResponseDetailFormat":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "type":"object", "properties":{ "CertificateRecordDetails":{ "type":"object", "required":[ "certificateRecord" ], "properties":{ "certificateRecord":{ "type":"string", "example":"Test" }, "data":{ "type":"array", "items":{ "type":"object", "properties":{ "version":{ "type":"string" }, "serialNumber":{ "type":"string" }, "signatureAlgorithm":{ "type":"string" }, "issuer":{ "type":"object", "$ref":"#/components/schemas/CertificateSubjectIssuer" }, "validity":{ "type":"object", "properties":{ "notBefore":{ "type":"string", "example":"2020-07-21T05:41:55Z" }, "notAfter":{ "type":"string", "example":"2021-07-21T05:41:55Z" } } }, "subject":{ "type":"object", "$ref":"#/components/schemas/CertificateSubjectIssuer" }, "x509V3Extensions":{ "type":"string", "example":"X509v3 extensions:\n X509v3 Basic Constraints:\n CA:FALSE\n X509v3 Key Usage: \n Digital Signature, Key Encipherment" } } } } } } } }, "messages":{ "type":"object" }, "links":{ "type":"object" } } }, "CertificateGETResponsePemFormat":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "type":"object", "properties":{ "CertificateRecordDetails":{ "type":"object", "required":[ "certificateRecord", "certificateRequest" ], "properties":{ "certificateRecord":{ "type":"string", "example":"Test" }, "certificateRequest":{ "type":"string", "example":"-----BEGIN PKCS7-----\n MIICzTCCAbUCAQAwVTELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAk1BMRMwEQYDVQQH\n EwpCdXJsaW5ndG9uMRQwEgYDVQQKEwtFbmdpbmVlcmluZzEOMAwGA1UEAxMFdGVz\n tm7DBKYUNlwHXNNOwv/X54eHXskIxTcpR9aimrKpkPNt4DffotoyU6sVXHfQApAZk\n -----END PKCS7-----" } } } } }, "messages":{ "type":"object" }, "links":{ "type":"object" } } }, "ConfigurationVersionsResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "type":"object", "properties":{ "configVersions":{ "type":"object", "required":[ "currentVersion", "runningVersion" ], "properties":{ "currentVersion":{ "type":"integer", "example":54 }, "runningVersion":{ "type":"integer", "example":53 } } } } }, "messages":{ "type":"object" }, "links":{ "type":"object" } } }, "GenerateCertSigningRequestResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "type":"object", "properties":{ "CertificateRequest":{ "type":"object", "required":[ "recordName", "certificateSignedRequest" ], "properties":{ "recordName":{ "type":"string" }, "certificateSignedRequest":{ "type":"string", "example":"-----BEGIN CERTIFICATE REQUEST-----\n MIICzTCCAbUCAQAwVTELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAk1BMRMwEQYDVQQH\n EwpCdXJsaW5ndG9uMRQwEgYDVQQKEwtFbmdpbmVlcmluZzEOMAwGA1UEAxMFdGVz\n tm7DBKYUNlwHXNNOwv/X54eHXskIxTcpR9aimrKpkPNt4DffotoyU6sVXHfQApAZk\n -----END CERTIFICATE REQUEST-----" } } } } } } }, "ImportCertificateRequest":{ "type":"object", "xml":{ "name":"ImportCertificate" }, "properties":{ "recordName":{ "type":"string" }, "format":{ "type":"string", "enum":[ "x509", "pkcs7", "try-all" ] }, "certificateRequest":{ "type":"string", "example":"-----BEGIN CERTIFICATE-----\n MIICzTCCAbUCAQAwVTELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAk1BMRMwEQYDVQQH\n EwpCdXJsaW5ndG9uMRQwEgYDVQQKEwtFbmdpbmVlcmluZzEOMAwGA1UEAxMFdGVz\n tm7DBKYUNlwHXNNOwv/X54eHXskIxTcpR9aimrKpkPNt4DffotoyU6sVXHfQApAZk\n -----END CERTIFICATE-----" } } }, "ImportCertificateResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "type":"object", "properties":{ "ImportCertificate":{ "type":"object", "required":[ "recordName" ], "properties":{ "recordName":{ "type":"string" } } } } }, "messages":{ "type":"object" }, "links":{ "type":"object" } } }, "NameValuePair":{ "type":"object", "required":[ "name", "value" ], "properties":{ "name":{ "type":"string" }, "value":{ "oneOf":[ { "type":"string" }, { "type":"integer" }, { "type":"number" }, { "type":"boolean" } ] } } }, "SingleConfigElement":{ "type":"object", "xml":{ "name":"configElement" }, "properties":{ "elementType":{ "type":"string" }, "attribute":{ "type":"array", "xml":{ "wrapped":false }, "items":{ "$ref":"#/components/schemas/NameValuePair" } }, "subElement":{ "type":"array", "xml":{ "wrapped":false }, "items":{ "type":"object" } } } }, "SingleConfigElementInData":{ "type":"object", "xml":{ "name":"data" }, "required":[ "configElement" ], "properties":{ "configElement":{ "type":"object", "required":[ "elementType", "attribute" ], "properties":{ "elementType":{ "type":"string" }, "attribute":{ "type":"array", "xml":{ "wrapped":false }, "items":{ "$ref":"#/components/schemas/NameValuePair" } }, "subElement":{ "type":"array", "xml":{ "wrapped":false }, "items":{ "type":"object" } } } } } }, "MultipleConfigElementsInData":{ "type":"object", "xml":{ "name":"data" }, "required":[ "configElement" ], "properties":{ "configElement":{ "type":"array", "xml":{ "wrapped":false }, "items":{ "type":"object", "xml":{ "name":"configElement" }, "required":[ "elementType", "attribute" ], "properties":{ "elementType":{ "type":"string" }, "attribute":{ "type":"array", "xml":{ "wrapped":false }, "items":{ "$ref":"#/components/schemas/NameValuePair" } }, "subElement":{ "type":"array", "xml":{ "wrapped":false }, "items":{ "type":"object" } } } } }, "pageInfo":{ "properties":{ "totalElementsConfigured":{ "type":"integer" }, "numElementsThisResponse":{ "type":"integer" }, "startingOffsetThisResponse":{ "type":"integer" } } } } }, "SingleElementInstanceResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "$ref":"#/components/schemas/SingleConfigElementInData" }, "messages":{ "type":"object" }, "links":{ "type":"object" } } }, "MultipleElementInstancesResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "$ref":"#/components/schemas/MultipleConfigElementsInData" }, "messages":{ "type":"object" }, "links":{ "type":"object" } } }, "TopLevelTemplateInData":{ "type":"object", "xml":{ "name":"data" }, "required":[ "configElement" ], "properties":{ "configElement":{ "type":"object", "required":[ "elementType", "attribute" ], "properties":{ "elementType":{ "type":"string" }, "attribute":{ "type":"array", "xml":{ "wrapped":false }, "items":{ "$ref":"#/components/schemas/NameValuePair" } }, "subElement":{ "type":"array", "xml":{ "wrapped":false }, "items":{ "type":"object" } } } } } }, "SubElementTemplateInData":{ "type":"object", "xml":{ "name":"data" }, "required":[ "configElement" ], "properties":{ "configElement":{ "type":"object", "required":[ "path", "subElementType", "attribute" ], "properties":{ "path":{ "type":"string" }, "subElementType":{ "type":"string" }, "attribute":{ "type":"array", "xml":{ "wrapped":false }, "items":{ "$ref":"#/components/schemas/NameValuePair" } }, "subElement":{ "type":"array", "xml":{ "wrapped":false }, "items":{ "type":"object" } } } } } }, "TemplateResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "oneOf":[ { "$ref":"#/components/schemas/TopLevelTemplateInData" }, { "$ref":"#/components/schemas/SubElementTemplateInData" } ] }, "messages":{ "type":"object" }, "links":{ "type":"object" } } }, "SingleElementMetadata":{ "type":"object", "xml":{ "name":"data" }, "required":[ "elementType", "singleInstance", "elementMetadata" ], "properties":{ "elementType":{ "type":"string" }, "singleInstance":{ "type":"boolean" }, "attributeMetadata":{ "type":"array", "xml":{ "wrapped":false }, "items":{ "type":"object", "xml":{ "name":"attributeMetadata" } } } } }, "SingleElementMetadataResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "$ref":"#/components/schemas/SingleElementMetadata" }, "messages":{ "type":"object" }, "links":{ "type":"object" } } }, "BootparametersInRequest":{ "type":"object", "xml":{ "name":"bootparams" }, "properties":{ "bootparam":{ "type":"array", "items":{ "$ref":"#/components/schemas/NameValuePair" } } } }, "AuthenticationTokenInData":{ "type":"object", "xml":{ "name":"data" }, "required":[ "accessToken" ], "properties":{ "accessToken":{ "type":"string" } } }, "AuthenticationTokenResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "$ref":"#/components/schemas/AuthenticationTokenInData" }, "messages":{ "type":"object" }, "links":{ "type":"object" } } }, "BootparametersInData":{ "type":"object", "xml":{ "name":"data" }, "required":[ "bootparams" ], "properties":{ "bootparams":{ "type":"array", "items":{ "type":"object", "properties":{ "bootparam":{ "$ref":"#/components/schemas/NameValuePair" } } } } } }, "BootparametersResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "$ref":"#/components/schemas/BootparametersInData" }, "messages":{ "type":"object" }, "links":{ "type":"object" } } }, "ElementTypesInData":{ "xml":{ "name":"data" }, "type":"object", "required":[ "elementTypes" ], "properties":{ "elementTypes":{ "type":"array", "xml":{ "wrapped":false }, "items":{ "type":"object", "xml":{ "name":"elementType" }, "required":[ "name", "description" ], "properties":{ "single":{ "type":"boolean", "xml":{ "attribute":true } }, "name":{ "type":"string" }, "description":{ "type":"string" } } } } } }, "ElementTypesResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "$ref":"#/components/schemas/ElementTypesInData" }, "messages":{ "type":"object" }, "links":{ "type":"object" } } }, "RebootResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "type":"string", "example":"Rebooting in 5 seconds" }, "messages":{ "type":"object" }, "links":{ "type":"object" } } }, "GenericErrorsResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "type":"object" }, "messages":{ "type":"array", "items":{ "type":"object", "properties":{ "errorMessage":{ "type":"string", "example":"Error message string" } } } }, "links":{ "type":"array", "items":{ "type":"object", "properties":{ "link":{ "description":"If available, a message with possible valid API URL(s) for the client to invoke", "type":"string", "example":"Available URL(s) message string" } } } } } }, "ImmediateAynchronousResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "type":"object" }, "messages":{ "type":"object" }, "links":{ "type":"object", "properties":{ "link":{ "type":"string" } } } } }, "AsyncStatusResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "type":"object", "properties":{ "operationState":{ "type":"object", "required":[ "operation", "status" ], "properties":{ "operation":{ "type":"string", "enum":[ "activate", "save", "verify", "restore", "backup" ] }, "status":{ "type":"string", "enum":[ "fail", "success", "inProgress" ] }, "errorMessage":{ "type":"string" } } }, "additionalInfo":{ "type":"object", "description":"A request-specific structure that contains response information related to the original asynchronous request." } } }, "messages":{ "type":"object" }, "links":{ "type":"object" } } }, "StatisticsCollectionsResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "type":"object", "properties":{ "collectionStatus":{ "type":"object", "properties":{ "status":{ "type":"string", "enum":[ "running", "stopped" ] }, "groups":{ "type":"array", "items":{ "type":"object", "properties":{ "group":{ "type":"object", "required":[ "name", "bootState", "startTime", "endTime" ], "properties":{ "licensed":{ "type":"string", "enum":[ true, false ], "xml":{ "attribute":true } }, "name":{ "type":"string", "example":"sip-sessions" }, "bootState":{ "type":"string", "enum":[ "enabled", "disabled" ] }, "startTime":{ "type":"string", "oneOf":[ { "type":"string", "example":"2018-09-05T08:41:55.0-0400" }, { "type":"string", "enum":[ "now", "never" ] } ] }, "endTime":{ "type":"string", "items":{ "oneOf":[ { "type":"string", "example":"2018-09-05T08:41:55.0-0400" }, { "type":"string", "enum":[ "now", "never" ] } ] } } } } } } }, "push":{ "type":"object", "properties":{ "nextPush":{ "type":"string", "example":"2018-09-05T10:41:55.0-0400" }, "subsequentPush":{ "type":"integer", "example":15 } } }, "pushReceivers":{ "type":"array", "items":{ "type":"object", "properties":{ "pushReceiver":{ "type":"object", "properties":{ "address":{ "type":"string", "example":"10.196.72.171" }, "state":{ "type":"string", "enum":[ "reachable", "unreachable" ], "example":"reachable" } } } } } } } } } }, "messages":{ "type":"object" }, "links":{ "type":"object" } } }, "StatisticsKpisDataResponse1":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "description":"KPI data. There can be one or more KPIs in the <data> object.", "type":"object", "properties":{ "(actual containerName)":{ "description":"This is a KPI container. The name of the tag is shown in parentheses because it is variable and dependent on the actual container name. It may or may not be the same as the type depending on the KPI type specified. Some types may have multiple containers.", "type":"object", "properties":{ "(actual KPI name)":{ "description":"This is the KPI name. The name of the tag is shown in parentheses because it is variable and dependent on the actual KPI. The value enclosed by this tag is also shown in parentheses because it is variable and its value is the actual KPI data value.", "type":"string", "example":"(Actual KPI value)" } } } } }, "messages":{ "type":"object" }, "links":{ "type":"array", "items":{ "type":"object", "properties":{ "link":{ "description":"Link to related KPI schema to match the KPI data response", "type":"string", "example":"https://{managementIp}/rest/v1.1/statistics/kpiTypes?type=sessCapacityUtil" } } } } } }, "StatisticsKpisDiscoveryResponse1":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "type":"object" }, "messages":{ "type":"object" }, "links":{ "description":"KPI discovery hypermedia links. List of available KPI types.", "type":"array", "items":{ "type":"object", "properties":{ "link":{ "description":"Links point to metadata of the available types.", "type":"string" } } }, "example":[ { "link":"https://{managementIp}/rest/{version}/statistics/kpiTypes?type=sessCapacityUtil" }, { "link":"https://{managementIp}/rest/{version}/statistics/kpiTypes?type=sysCPUUtil" }, { "link":"https://{managementIp}/rest/{version}/statistics/kpiTypes?type=sysMemoryUtil" }, { "link":"https://{managementIp}/rest/{version}/statistics/kpiTypes?type=globalSessions" } ] } } }, "StatisticsKpisMetadataResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "description":"KPIs metadata (schemas)", "type":"array", "items":{ "type":"object", "properties":{ "httpMethod":{ "description":"HTTP method to use with URL in <links> section", "type":"string", "enum":[ "GET" ] }, "name":{ "description":"Descriptive name of KPI type", "type":"string", "example":"Get Session Capacity Utilization" }, "kpis":{ "type":"array", "items":{ "type":"object", "properties":{ "containerName":{ "description":"Name of the KPI container. There can be one or more KPI containers in the <kpis> object. Therefore, this may not map directly to the KPI type depending on the number of containers.", "type":"string", "example":"sessCapacityUtil" }, "kpi":{ "description":"KPI metadata (schema).", "type":"object", "properties":{ "name":{ "description":"KPI name", "type":"string", "example":"percentCap" }, "description":{ "description":"KPI description", "type":"string", "example":"The percentage of session capacity utilization" }, "dataType":{ "description":"KPI data type", "type":"string", "enum":[ "integer", "number" ], "example":"integer" }, "metricType":{ "description":"Metric type. Counter and gauge types are supported. Counters KPIs cumulative metrics that only increase in value or get reset to zero. Gauge KPIs are numerical values that can increase or decrease.", "type":"string", "enum":[ "counter", "gauge" ], "example":"integer" }, "units":{ "description":"KPI units of measurement. This will be empty if there are no units of measurement for the data.", "type":"string", "enum":[ "bytes", "calls", "calls per second", "messages", "messages per second", "percent", "seconds" ], "example":"percent" } } } } } } } } }, "messages":{ "type":"object" }, "links":{ "description":"KPI data links", "type":"array", "items":{ "type":"object", "properties":{ "link":{ "description":"Link to related KPI data to match the metadata response", "type":"string", "example":"https://{managementIp}/rest/{version}/statistics/kpis?type=sessCapacityUtil" } } } } } }, "SupportedVersionsResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "type":"object", "properties":{ "supportedVersions":{ "type":"object", "properties":{ "latestVersion":{ "type":"string", "description":"Latest API version", "example":"v1.2" }, "otherVersions":{ "type":"array", "description":"Previous API versions for backwards compatibility", "items":{ "type":"object", "properties":{ "version":{ "type":"string", "example":"v1.1" } } } } } } } }, "messages":{ "type":"object" }, "links":{ "type":"object" } } }, "SystemHardwareResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "type":"object", "properties":{ "hardwareInformation":{ "description":"Hardware entities. Note: Not all fields apply to all types of hardware.", "type":"array", "items":{ "type":"object", "properties":{ "entity":{ "properties":{ "description":{ "type":"string", "description":"Description of hardware entity" }, "containedIn":{ "type":"integer", "description":"Index of hardware containing this entity" }, "classDescr":{ "type":"string", "description":"Class of hardware" }, "parentRelPos":{ "type":"integer", "description":"Index of relative position to parent hardware entity" }, "name":{ "type":"string", "description":"Name of hardware entity" }, "hardwareRev":{ "type":"string", "description":"Hardware revision" }, "firmwareRev":{ "type":"string", "description":"Firmware revision" }, "serialNum":{ "type":"string", "description":"Serial number" }, "mfgName":{ "type":"string", "description":"Manufacturer name" }, "modeName":{ "type":"string", "description":"Model name" }, "isFRU":{ "type":"boolean", "enum":[ true, false ], "description":"Flag to indicate if hardware is field replaceable" } }, "example":{ "description":"Assy, Acme Packet 3900 Main Board", "containedIn":5, "classDescr":"module", "parentRelPos":1, "name":"Main Board", "hardwareRev":0.05, "firmwareRev":0, "serialNum":"181613000131", "mfgName":"MiTAC China - MSL", "modeName":"Main Board I", "isFRU":false } } } } } } }, "messages":{ "type":"object" }, "links":{ "type":"object" } } }, "SystemInformationResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "type":"object", "properties":{ "systemInformation":{ "type":"object", "properties":{ "productName":{ "type":"string", "description":"Product Name" }, "buildVersion":{ "type":"string", "description":"Software Build Version" }, "upTimeSeconds":{ "type":"integer", "description":"System uptime in seconds" }, "location":{ "type":"string", "description":"System Location" }, "name":{ "type":"string", "description":"System Name" }, "serialNum":{ "type":"string", "description":"Serial Number" } }, "example":{ "productName":"Acme Packet 3900", "buildVersion":"TCZ0.0.111 Alpha 17 (WS Build 93)", "upTimeSeconds":3986, "location":"outerLab", "name":"dev3900", "serialNum":"181613000131" } } } }, "messages":{ "type":"object" }, "links":{ "type":"object" } } }, "SystemStatusResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "type":"object", "properties":{ "upTime":{ "type":"integer", "example":861830 }, "hostName":{ "type":"string", "example":"thewater-sd" }, "systemState":{ "type":"string", "enum":[ "online", "offline" ], "example":"online" }, "role":{ "type":"string", "enum":[ "active", "standby", "out of service" ], "example":"active" }, "healthScorePercent":{ "type":"integer", "minimum":0, "maximum":100, "example":100 }, "haSyncState":{ "type":"array", "items":{ "type":"object", "properties":{ "component":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"tCCD" }, "state":{ "type":"string", "enum":[ "disabled", "enabled", true, false ], "example":"disabled" } } } } } }, "haSockets":{ "type":"integer", "example":2 }, "haHealthScorePercent":{ "type":"integer", "minimum":0, "maximum":100, "example":100 }, "haPeerName":{ "type":"string", "example":"thewater-ed" }, "haPeerRole":{ "type":"string", "enum":[ "active", "standby", "out of service" ], "example":"standby" }, "haSwitchOvers":{ "type":"integer", "example":2 }, "switchOverLogs":{ "type":"array", "items":{ "type":"object", "properties":{ "switchOver":{ "type":"object", "properties":{ "newState":{ "type":"string", "enum":[ "Active", "RelinquishingActive" ], "example":"RelinquishingActive" }, "oldState":{ "type":"string", "enum":[ "Active", "RelinquishingActive" ], "example":"Active" }, "info":{ "type":"string", "example":"Active to RelinquishingActive, forced by command" }, "time":{ "type":"string", "example":"2018-09-05T08:41:55.0-0400" } } } } } } } }, "messages":{ "type":"object" }, "links":{ "type":"object" } } }, "SystemStorageResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "type":"array", "items":{ "type":"object", "properties":{ "storage":{ "type":"array", "items":{ "type":"object", "required":[ "volume", "totalBytes", "availableBytes", "usedBytes" ], "properties":{ "volume":{ "type":"string", "example":"/boot" }, "totalBytes":{ "type":"integer", "example":1995030528 }, "availableBytes":{ "type":"integer", "example":1682923520 }, "usedBytes":{ "type":"integer", "example":312107008 } } } } } } }, "messages":{ "type":"object" }, "links":{ "type":"object" } } }, "SystemStorageErrorsResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "type":"object" }, "messages":{ "type":"object", "properties":{ "errorMessage":{ "type":"string", "example":"Unknown resource requested: [POST]:system/storage" } } }, "links":{ "type":"object", "properties":{ "link":{ "type":"string", "example":"https://thewater-sd/rest/v1.1/system/storage" } } } } }, "SystemVersionResponse":{ "xml":{ "name":"response" }, "type":"object", "required":[ "data", "messages", "links" ], "properties":{ "data":{ "type":"object", "properties":{ "systemVersionInfo":{ "type":"object", "required":[ "productName", "buildVersion", "oracleLinuxInfo", "buildDate", "buildView", "buildCycle", "user", "host" ], "properties":{ "productName":{ "type":"string", "example":"Acme Packet OS VM" }, "buildVersion":{ "type":"string", "example":"TCZ0.0.111 Alpha 14 (WS Build 85)" }, "oracleLinuxInfo":{ "type":"string", "example":"branches-7/el7-u5 {2018-07-23T07:00:00+0000}" }, "buildDate":{ "type":"string", "example":"2018-09-05T08:41:55.0-0400" }, "buildView":{ "type":"string", "example":"/home/acmedev/cc/acmedev_RESTLESS_BUILD-6" }, "buildCycle":{ "type":"integer", "example":55 }, "user":{ "type":"string", "example":"acmedev" }, "host":{ "type":"string", "example":"acme123" } } } } }, "messages":{ "type":"object" }, "links":{ "type":"object" } } } } } }