SVC MCU



[tags: DMA,RPRM]

Resource Root

https://localhost:8443/api/rest/svc-mcus

Summary


Resources Methods
https://localhost:8443/api/rest/svc-mcus

GET Retrieves SVC MCUs.

POST  Creates an SVC MCU definition.

https://localhost:8443/api/rest/svc-mcus/alert-count

GET  Retrieves total number of alerts on all svc mcus.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}

GET  Retrieves an SVC MCU.

PUT Updates information about an MCU.

DELETE Deletes an MCU.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/set-service-status

POST  Sets the service status for the specified MCU.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/restart

POST  Reboots the specified MCU.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/factory-reset

POST  Resets the SVC MCU to factory defaults.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/logs

GET  Get the list of available SVC MCU logs.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/download-logs

POST  Request to initiate the process to download the set of logs, as described in the request.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/cancel-task

POST  Request to cancel an ongoing task (Cancel log downloading, for example).

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/packet-capture/start

POST  Request to initiate the packet capture process on svc mcu [tags: DMA] .

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/packet-capture/stop

POST  Request to stop the packet capture process on svc mcu [tags: DMA] .

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/users

GET  Retrieves list of users on this SVC MCU.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/users/{user-name}

GET  Retrieves a specific user on this SVC MCU.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/users/{user-name}

PUT  Update a specific user on this SVC MCU.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/certificates

POST  Install an X509 certificate, PKCS7 or PKCS12 file.

POST  Install PEM-formatted certificate(s) from text.

GET  Get details in text for all the currently installed certificates.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/certificates/reset-to-selfsigned

POST  Regenerate the self signed certificate.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/certificates/status

GET  Indicates the need for a reboot due to the installation of new certificates.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/certificates/csr

POST  Create a new certificate signing request.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/certificates/ocsp-settings

GET  Get the OCSP settings for this media relay.

PUT  Update the OCSP settings for the system.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/certificates/{alias}

DELETE  Delete the certificate identified by the alias.

Resources


https://localhost:8443/api/rest/svc-mcus


Methods

GET

Retrieves SVC MCUs. [tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-svc-mcu-list+xml
application/vnd.plcm.plcm-svc-mcu-list+json
Information successfully retrieved
304
SVC MCUs information has not changed since the last search.

Note: The API client must provide the "plcm-svc-mcu-list"
representation's ETag value in the "If-None-Match" HTTP header to
ensure conditional retrieval. This will improve network performance
by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous,
identical search in the "If-None-Match" header, then the HTTP
response will contain the search results in the message body.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator,
provisioner

POST


Creates an SVC MCU definition.
Name, management address, username, and password are required.
DMA roles required: administrator
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-svc-mcu+xml
application/vnd.plcm.plcm-svc-mcu+json

Response

Status Representation Description
201 The SVC MCU definition was created successfully.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Bad request.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Name is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The supplied name contains invalid characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Management address is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The supplied management address is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The management username is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The management password is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
MCU name is already used.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Management address is already used.

https://localhost:8443/api/rest/svc-mcus/alert-count


Methods

GET


Retrieves total number of alerts on all svc mcus. Etag's calculation includes configuration fields only.
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-svc-mcu-alert-count+xml
application/vnd.plcm.plcm-svc-mcu-alert-count+json
Information successfully retrieved
304
Alert count has not changed since the last search.

Note: The API client must provide the "plcm-svc-mcu" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional
retrieval. This will improve network performance by reducing bandwidth
consumption.

If the API client chooses to exclude an ETag value from a previous,
identical search in the "If-None-Match" header, then the HTTP response will
contain the search results in the message body.

The "plcm-svc-mcu" ETag can be accessed from the initial search
result's HTTP response header. Also, subsequent searches require the identical search
filter to ensure an equivalent ETag value. This also assumes no other
client made changes to the External SIP Peer on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: Administrator

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}


Template Parameters

Name Type Description
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.

Methods

GET


Retrieves an SVC MCU. Etag's calculation includes configuration fields only.
[tags: DMA]

Request

Query Parameters

Name Type Description
type xs:string
Specifies an enumerated type that will indicate that the resource should be read by its
human-readable name or immutable, unique identifier such as a UUID, integer, etc.

The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its human-readable name. Unfortunately, the name can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.

Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{value}?type={name|id}
Note 2: If the "name" enumeration is specified, then the value should correspond to the name.
Otherwise, the resource cannot not be found.
Note 3: If the "id" enumeration is specified, the value should correspond to the unique
identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "id" type enumeration. As a result, the {value} parameter
can simply specify the unique identifier and the query parameter, "?type=id", is not required.
Note 5: The Etag's calculation includes configuration fields (as opposed to status). DMA can
modify configuration fields but cannot modify status fields.

Response

Status Representation Description
200 application/vnd.plcm.plcm-svc-mcu+xml
application/vnd.plcm.plcm-svc-mcu+json
Information successfully retrieved
304
MCU information has not changed since the last search.

Note: The API client must provide the "plcm-svc-mcu" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional
retrieval. This will improve network performance by reducing bandwidth
consumption.

If the API client chooses to exclude an ETag value from a previous,
identical search in the "If-None-Match" header, then the HTTP response will
contain the search results in the message body.

The "plcm-svc-mcu" ETag can be accessed from the initial search
result's HTTP response header. Also, subsequent searches require the identical search
filter to ensure an equivalent ETag value. This also assumes no other
client made changes to the External SIP Peer on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: Administrator
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such MCU.

PUT

Updates information about an MCU. [tags: DMA]

Request

Query Parameters

Name Type Description
type xs:string
Specifies an enumerated type that will indicate that the resource should be read by its
human-readable name or immutable, unique identifier such as a UUID, integer, etc.

The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its human-readable name. Unfortunately, the name can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.

Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{value}?type={name|id}
Note 2: If the "name" enumeration is specified, then the value should correspond to the name.
Otherwise, the resource cannot not be found.
Note 3: If the "id" enumeration is specified, the value should correspond to the unique
identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "id" type enumeration. As a result, the {value} parameter
can simply specify the unique identifier and the query parameter, "?type=id", is not required.

Representations

application/vnd.plcm.plcm-svc-mcu+xml
application/vnd.plcm.plcm-svc-mcu+json

Response

Status Representation Description
204
MCU successfully updated.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Bad request.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such MCU.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Name is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The supplied name contains invalid characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Management address is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The supplied management address is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The management username is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The management password is required.

DELETE

Deletes an MCU. [tags: DMA]

Request

Query Parameters

Name Type Description
type xs:string
Specifies an enumerated type that will indicate that the resource should be read by its
human-readable name or immutable, unique identifier such as a UUID, integer, etc.

The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its human-readable name. Unfortunately, the name can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.

Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{value}?type={name|id}
Note 2: If the "name" enumeration is specified, then the value should correspond to the name.
Otherwise, the resource cannot not be found.
Note 3: If the "id" enumeration is specified, the value should correspond to the unique
identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "id" type enumeration. As a result, the {value} parameter
can simply specify the unique identifier and the query parameter, "?type=id", is not required.

Response

Status Representation Description
204 MCU deleted successfully.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU does not exist.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/set-service-status


Template Parameters

Name Type Description
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.

Methods

POST


Sets the service status for the specified MCU.

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-svc-mcu-set-service-status-request+xml
application/vnd.plcm.plcm-svc-mcu-set-service-status-request+json

Response

Status Representation Description
204 The service status for the MCU was set as specified.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU does not exist.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The requested service status value is not a viable option for this request.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU cannot be set to the specified service status because the MCU has active calls on it.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/restart


Template Parameters

Name Type Description
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.

Methods

POST


Reboots the specified MCU.

[tags: DMA]

Response

Status Representation Description
204 The MCU is rebooted.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU does not exist.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/factory-reset


Template Parameters

Name Type Description
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.

Methods

POST


Resets the SVC MCU to factory defaults.

[tags: DMA]

Response

Status Representation Description
204 The MCU is reset to factory defaults.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU does not exist.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/logs


Template Parameters

Name Type Description
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.

Methods

GET


Get the list of available SVC MCU logs.

[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-log-archive-list+xml
application/vnd.plcm.plcm-log-archive-list+json
Information successfully retrieved
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU does not exist.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/download-logs


Template Parameters

Name Type Description
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.

Methods

POST


Request to initiate the process to download the set of logs, as described in the request.
A resource URL to check the status of the download operation will be returned in the Location header.

[tags: DMA]

Response

Status Representation Description
202 application/vnd.plcm.plcm-svc-mcu-log-download-request+xml
application/vnd.plcm.plcm-svc-mcu-log-download-request+json
Log download successfully started
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU does not exist.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/cancel-task


Template Parameters

Name Type Description
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.

Methods

POST


Request to cancel an ongoing task (Cancel log downloading, for example).
[tags: DMA]

Response

Status Representation Description
202 Task successfully cancelled
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU does not exist.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/packet-capture/start


Template Parameters

Name Type Description
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.

Methods

POST


Request to initiate the packet capture process on svc mcu

[tags: DMA]

Response

Status Representation Description
202 application/vnd.plcm.plcm-svc-mcu-packet-capture-request+xml
application/vnd.plcm.plcm-svc-mcu-packet-capture-request+json
Packet capture successfully started
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU does not exist.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/packet-capture/stop


Template Parameters

Name Type Description
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.

Methods

POST


Request to stop the packet capture process on svc mcu

[tags: DMA]

Response

Status Representation Description
202 Packet capture successfully stopped
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU does not exist.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/users


Template Parameters

Name Type Description
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.

Methods

GET


Retrieves list of users on this SVC MCU. Etag's calculation includes configuration fields only.
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-svc-mcu+xml
application/vnd.plcm.plcm-svc-mcu+json
Information successfully retrieved
304
MCU information has not changed since the last search.

Note: The API client must provide the "plcm-svc-mcu" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional
retrieval. This will improve network performance by reducing bandwidth
consumption.

If the API client chooses to exclude an ETag value from a previous,
identical search in the "If-None-Match" header, then the HTTP response will
contain the search results in the message body.

The "plcm-svc-mcu" ETag can be accessed from the initial search
result's HTTP response header. Also, subsequent searches require the identical search
filter to ensure an equivalent ETag value. This also assumes no other
client made changes to the External SIP Peer on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: Administrator
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such MCU.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/users/{user-name}


Template Parameters

Name Type Description
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.
user-name xs:string User Name

Methods

GET


Retrieves a specific user on this SVC MCU. Etag's calculation includes configuration fields only.
[tags: DMA]

Request

Query Parameters

Name Type Description
type xs:string
Specifies an enumerated type that will indicate that the resource should be read by its
human-readable name or immutable, unique identifier such as a UUID, integer, etc.

The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its human-readable name. Unfortunately, the name can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.

Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{value}?type={name|id}
Note 2: If the "name" enumeration is specified, then the value should correspond to the name.
Otherwise, the resource cannot not be found.
Note 3: If the "id" enumeration is specified, the value should correspond to the unique
identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "id" type enumeration. As a result, the {value} parameter
can simply specify the unique identifier and the query parameter, "?type=id", is not required.
Note 5: The Etag's calculation includes configuration fields (as opposed to status). DMA can
modify configuration fields but cannot modify status fields.

Response

Status Representation Description
200 application/vnd.plcm.plcm-svc-mcu+xml
application/vnd.plcm.plcm-svc-mcu+json
Information successfully retrieved
304
User information has not changed since the last search.

Note: The API client must provide the "plcm-svc-mcu" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional
retrieval. This will improve network performance by reducing bandwidth
consumption.

If the API client chooses to exclude an ETag value from a previous,
identical search in the "If-None-Match" header, then the HTTP response will
contain the search results in the message body.

The "plcm-svc-mcu" ETag can be accessed from the initial search
result's HTTP response header. Also, subsequent searches require the identical search
filter to ensure an equivalent ETag value. This also assumes no other
client made changes to the External SIP Peer on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: Administrator
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such MCU.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/users/{user-name}


Template Parameters

Name Type Description
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.
user-name xs:string User Name

Methods

PUT


Update a specific user on this SVC MCU. Etag's calculation includes configuration fields only.
[tags: DMA]

Request

Query Parameters

Name Type Description
type xs:string
Specifies an enumerated type that will indicate that the resource should be read by its
human-readable name or immutable, unique identifier such as a UUID, integer, etc.

The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its human-readable name. Unfortunately, the name can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.

Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{value}?type={name|id}
Note 2: If the "name" enumeration is specified, then the value should correspond to the name.
Otherwise, the resource cannot not be found.
Note 3: If the "id" enumeration is specified, the value should correspond to the unique
identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "id" type enumeration. As a result, the {value} parameter
can simply specify the unique identifier and the query parameter, "?type=id", is not required.
Note 5: The Etag's calculation includes configuration fields (as opposed to status). DMA can
modify configuration fields but cannot modify status fields.

Response

Status Representation Description
204 application/vnd.plcm.plcm-svc-mcu+xml
application/vnd.plcm.plcm-svc-mcu+json
Information successfully updated
304
User information has not changed since the last search.

Note: The API client must provide the "plcm-svc-mcu" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional
retrieval. This will improve network performance by reducing bandwidth
consumption.

If the API client chooses to exclude an ETag value from a previous,
identical search in the "If-None-Match" header, then the HTTP response will
contain the search results in the message body.

The "plcm-svc-mcu" ETag can be accessed from the initial search
result's HTTP response header. Also, subsequent searches require the identical search
filter to ensure an equivalent ETag value. This also assumes no other
client made changes to the External SIP Peer on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: Administrator
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such MCU.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/certificates


Template Parameters

Name Type Description
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.

Methods

POST


Install an X509 certificate, PKCS7 or PKCS12 file. X509 and
PKCS7 files can be in either DER or PEM format. If the file is
PKCS12, a password must be provided in plain text in the 'password'
parameter. Data should be uploaded using 'multipart/form-data'
semantics, defined in RFC 7578, with a 'file' part and a 'password'
part. The 'file' part should use a Content-Type of
'application/octet-stream' in all cases. The 'password' part may
omit the Content-Type, but if supplied, should use a Content-Type
of 'text/plain'.

The need for a reboot can be established with the
method "/certificates/status".

IMPORTANT: Changes to certificates will not take effect until the
system has been rebooted. To restart the system, use the
API restart method.

[tags: DMA]

Request

Representations

multipart/form-data

Response

Status Representation Description
201
The file's contents were installed successfully. A reboot is
required to take effect.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The 'file' multipart parameter was not supplied.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

Unauthorized. Administrator privileges are required.
409 application/vnd.plcm.plcm-pkix-certificate-status+xml
application/vnd.plcm.plcm-pkix-certificate-status+json

Errors and/or warnings have occurred during the installation
of this certificate. Check the body of the response for a list of
the errors and/or warnings.

POST


Install PEM-formatted certificate(s) from text. The text for
the PEM entry can contain one or more certificates.

IMPORTANT: Changes to certificates will not take effect until the
system has been rebooted. To restart the system, use the
API restart method.
[tags: DMA]

Request

Representations

text/plain

Response

Status Representation Description
201
The PEM certificates were installed successfully. A reboot is
required to take effect.
409 application/vnd.plcm.plcm-pkix-certificate-status+xml
application/vnd.plcm.plcm-pkix-certificate-status+json

Errors and/or warnings have occurred during the installation
of this certificate. Check the body of the response for a list of
the errors and/or warnings.

GET


Get details in text for all the currently installed certificates.
[tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-certificate-info-list+xml
plcm-pkix-certificate-info-list:plcm-pkix-certificate-info-list+json
406 text/plain
Unacceptable. Invalid accept header.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/certificates/reset-to-selfsigned


Template Parameters

Name Type Description
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.

Methods

POST


Regenerate the self signed certificate.

IMPORTANT: Changes to certificates will not take
effect until the system has been rebooted. To restart the system,
use the API restart method.

[tags: DMA]

Request

Response

Status Representation Description
204 The self signed certificate is successful regenerated.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid credentials.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. regenerate self signed certificate
requires administrator role.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/certificates/status


Template Parameters

Name Type Description
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.

Methods

GET


Indicates the need for a reboot due to the installation of new
certificates.

[tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-pkix-status+xml
application/vnd.plcm.plcm-pkix-status+json
The indicator for reboot require is successfully retrieved.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid credentials.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. Get reboot status requires
administrator role.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/certificates/csr


Template Parameters

Name Type Description
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.

Methods

POST


Create a new certificate signing request. CAUTION: this will overwrite an existing CSR.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-pkix-certificate-signing-request+xml
application/vnd.plcm.plcm-pkix-certificate-signing-request+json

Response

Status Representation Description
201 application/vnd.plcm.plcm-pkix-certificate-signing-request+xml
application/vnd.plcm.plcm-pkix-certificate-signing-request+json
Certificate Signing Request successfully saved. The same Certificate
Signing request object is returned with the encoded request info filled in.
400 text/plain
Bad request.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User is not authorized to update the Certificate Signing
Request.
406 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Not Acceptable.
409 application/vnd.plcm.plcm-pkix-certificate-signing-request+xml
application/vnd.plcm.plcm-pkix-certificate-signing-request+json

One or more errors occurred while creating the CSR. See the CertificateStatus
field in the Certificate Signing Request included in the body
of the response for the specific messages.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/certificates/ocsp-settings


Template Parameters

Name Type Description
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.

Methods

GET


Get the OCSP settings for this media relay.

[tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-pkix-ocsp-settings+xml
application/vnd.plcm.plcm-pkix-ocsp-settings+json
Successfully retrieved OCSP settings for the system.
304
OCSP settings records have not changed since the last get.

Note: The API client must provide the "plcm-pkix-ocsp-settings"
representation's ETag value in the "If-None-Match" HTTP header to
ensure conditional retrieval. This will improve network
performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous,
identical search in the "If-None-Match" header, then the HTTP response
will contain the search results in the message body.

The "plcm-pkix-ocsp-settings" ETag can be accessed from the initial
search result's HTTP response header. Also, subsequent searches
require the identical search filter to ensure an equivalent ETag
value. This also assumes no other client made changes to the OCSP
settings on the server.
400 text/plain
Bad request.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The request contained ETags in both the header (header-ETag)
and the body (body-ETag) and they do not match.
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The resource has changed on the server. The API client must
retrieve the latest resource version, apply the resource
modifications, then update to the server.
428 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The API client must supply the ETag in the message body that
is bounded by the "entity-tag" XML tag. Refer to the
"plcm-pkix-ocsp-settings.xsd" for details. If the message body
does not contain the ETag value, the server will look for the
ETag in the "If-Match" header.

PUT


Update the OCSP settings for the system.

IMPORTANT:
Enabling/disabling of the OCSP settings will cause an immediate reboot
of the system. Changes to these settings should only be
performed when rebooting will cause the least interruption to
service.

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-ocsp-settings+xml
application/vnd.plcm.plcm-pkix-ocsp-settings+json

Response

Status Representation Description
204 OCSP settings record successfully updated.
428
OCSP settings have changed since the last retrieval.

Note: The response will contain the ETag value and link
that reflects the server's OCSP settings resource in the
HTTP response header.

The API client must supply the ETag in the message body that
is bounded by the "entity-tag" XML tag. Refer to the
"plcm-pkix-ocsp-settings.xsd" for details. If the message body
does not contain the ETag value, the server will look for the
ETag in the "If-Match" header.

The "plcm-pkix-ocsp-settings" ETag can be accessed from the
initial retrieval result's HTTP response header. This also
assumes no other client made changes to OCSP settings on
the server.
400 text/plain
Bad request.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User is not authorized to update the OCSP settings.
406 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Not Acceptable.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The request contained ETags in both the header (header-ETag)
and the body (body-ETag) and they do not match.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The OCSP responder URL is required if the OCSP certificate is
specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

Malformed OCSP Responder URL.
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The resource has changed on the server. The API client must
retrieve the latest resource version, apply the resource
modifications, then update to the server.
428 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The API client must supply the ETag in the message body that
is bounded by the "entity-tag" XML tag. Refer to the
"plcm-pkix-ocsp-settings.xsd" for details. If the message body
does not contain the ETag value, the server will look for the
ETag in the "If-Match" header.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/certificates/{alias}


Template Parameters

Name Type Description
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.
alias xs:string

Methods

DELETE


Delete the certificate identified by the alias.

IMPORTANT:
Changes to certificates will not take effect until the system has
been rebooted. To restart the system, use the
plcm-power-management API restart method.

[tags: DMA]

Request

Response

Status Representation Description
204 The certificate deleted successfully.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Requested resource could not be found.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
This certificate is in use and cannot be removed.