Signaling Config



[tags: DMA]

Resource Root

https://localhost:8443/api/rest/signaling

Summary


Resources Methods
https://localhost:8443/api/rest/signaling

https://localhost:8443/api/rest/signaling/sip

GET Retrieves SIP configuration.

PUT  Update current SIP configuration.

https://localhost:8443/api/rest/signaling/sip/default

GET Retrieves default SIP configuration.

https://localhost:8443/api/rest/signaling/gatekeeper

GET Retrieves gatekeeper configuration.

PUT  Update current gatekeeper configuration.

https://localhost:8443/api/rest/signaling/gatekeeper/default

GET Retrieves default gatekeeper configuration.

https://localhost:8443/api/rest/signaling/turn

GET Retrieves TURN configuration.

PUT  Update current TURN configuration.

https://localhost:8443/api/rest/signaling/turn/status

GET Retrieves current TURN status.

https://localhost:8443/api/rest/signaling/webrtc

GET Retrieves WebRTC configuration.

PUT  Update current WebRTC configuration.

https://localhost:8443/api/rest/signaling/webrtc/default

GET Retrieves default WebRTC configuration.

https://localhost:8443/api/rest/signaling/poly-evo

GET Retrieves Poly EVO configuration.

PUT  Update current Poly EVO configuration.

https://localhost:8443/api/rest/signaling/poly-evo/default

GET Retrieves default Poly EVO configuration.

https://localhost:8443/api/rest/signaling/acl

https://localhost:8443/api/rest/signaling/acl/variables

GET Retrieves ACL variables.

PUT  Update current ACL Variables.

https://localhost:8443/api/rest/signaling/restore-default

POST Restoring default signaling configuration.

https://localhost:8443/api/rest/signaling/status

GET Retrieves current signaling status for the H.

Resources


https://localhost:8443/api/rest/signaling


https://localhost:8443/api/rest/signaling/sip


Methods

GET

Retrieves SIP configuration. [tags: DMA]

Request

Query Parameters

Name Type Description
clusterName xs:string
Specifies the clusterName from which the config should be retrieved. If not provided, the name of the cluster handling the REST request is assumed.
clusterIdentifier xs:string
Specifies the clusterIdentifier from which the config should be retrieved. If not provided, the identifier of the cluster handling the REST request is assumed.

Response

Status Representation Description
200 application/vnd.plcm.plcm-sip-config+xml
application/vnd.plcm.plcm-sip-config+json
application/vnd.plcm.plcm-sip-config-v2+xml
application/vnd.plcm.plcm-sip-config-v2+json
application/vnd.plcm.plcm-sip-config-v3+xml
application/vnd.plcm.plcm-sip-config-v3+json
Information successfully retrieved
304
SIP information has not changed since the last search.

Note: The API client must provide the "plcm-sip-config" 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-sip-config" 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
conference templates on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Specified cluster does not exist

PUT


Update current SIP configuration.
DMA role required: administrator.

Note: In this and future versions, V1 and V2 are depricated.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-sip-config+xml
application/vnd.plcm.plcm-sip-config+json
application/vnd.plcm.plcm-sip-config-v2+xml
application/vnd.plcm.plcm-sip-config-v2+json
application/vnd.plcm.plcm-sip-config-v3+xml
application/vnd.plcm.plcm-sip-config-v3+json

Response

Status Representation Description
204
SIP config updated successfully. The ETag returned in the HTTP header represents the version
of the current configuration.
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
Unauthorized. DMA role required: administrator
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
SIP Configuration cannot be null.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid port number. Must be between 1024 and 65535.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Duplicated port number. This port has already been used.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The version of the sip config submitted for update does not match that on the server.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The request contained ETags in both the header and the body, and they do not match.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The Primary Dial Plan Port List must always contain at least one TLS Port.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Signaling type is either not provided, or does not match the content type. The acceptable values are either sip or gatekeeper.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
UDP-only Port is not allowed.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
alternate-dial-plan-prefixes are deprecated
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
A port cannot have tls-cert-validation-required flag set to TRUE when it is not a TLS port.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
acl-id for listening point is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
registration-policy-id for listening point is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The SIP ports must be different unless edge services are enabled and the wan and lan sides use different interfaces.

https://localhost:8443/api/rest/signaling/sip/default


Methods

GET

Retrieves default SIP configuration. [tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-sip-config+xml
application/vnd.plcm.plcm-sip-config+json
application/vnd.plcm.plcm-sip-config-v2+xml
application/vnd.plcm.plcm-sip-config-v2+json
application/vnd.plcm.plcm-sip-config-v3+xml
application/vnd.plcm.plcm-sip-config-v3+json
Information successfully retrieved
304
Default SIP information has not changed since the last search.

Note: The API client must provide the "plcm-sip-config" 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-sip-config" 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
conference templates 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/signaling/gatekeeper


Methods

GET

Retrieves gatekeeper configuration. [tags: DMA]

Request

Query Parameters

Name Type Description
clusterName xs:string
Specifies the clusterName from which the config should be retrieved. If not provided, the name of the cluster handling the REST request is assumed.
clusterIdentifier xs:string
Specifies the clusterIdentifier from which the config should be retrieved. If not provided, the identifier of the cluster handling the REST request is assumed.

Response

Status Representation Description
200 application/vnd.plcm.plcm-gatekeeper-config+xml
application/vnd.plcm.plcm-gatekeeper-config+json
application/vnd.plcm.plcm-gatekeeper-config-v2+xml
application/vnd.plcm.plcm-gatekeeper-config-v2+json
Information successfully retrieved
304
Gatekeeper information has not changed since the last search.

Note: The API client must provide the "plcm-gatekeeper-config" 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-gatekeeper-config" 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
conference templates on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Specified cluster does not exist

PUT


Update current gatekeeper configuration.
DMA role required: administrator.
Note: gk-port-from and gk-port-to fileds are read only fields so both values will be ignore in case of PUT request.
Note: In this and future versions, V1 is depricated.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-gatekeeper-config+xml
application/vnd.plcm.plcm-gatekeeper-config+json
application/vnd.plcm.plcm-gatekeeper-config-v2+xml
application/vnd.plcm.plcm-gatekeeper-config-v2+json

Response

Status Representation Description
204
Gatekeeper config updated successfully. The ETag returned in the HTTP header represents the version
of the current configuration.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Bad request
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unauthorized. DMA role required: administrator
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Gatekeeper Configuration cannot be null.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid port number. Must be between 1024 and 65535.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Duplicated port number. This port has already been used.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The version of the gatekeeper config submitted for update does not match that on the server.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The request contained ETags in both the header and the body, and they do not match.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Prefix cannot be empty.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Duplicated prefix.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Signaling type is either not provided, or does not match the content type. The acceptable values are either sip or gatekeeper.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
UDP-only Port is not allowed.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Prefix can only contain numeric characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
acl-id for listening point is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
registration-policy-id for listening point is required.

https://localhost:8443/api/rest/signaling/gatekeeper/default


Methods

GET

Retrieves default gatekeeper configuration. [tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-gatekeeper-config+xml
application/vnd.plcm.plcm-gatekeeper-config+json
application/vnd.plcm.plcm-gatekeeper-config-v2+xml
application/vnd.plcm.plcm-gatekeeper-config-v2+json
Information successfully retrieved
304
Default gatekeeper information has not changed since the last search.

Note: The API client must provide the "plcm-gatekeeper-config" 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-gatekeeper-config" 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
conference templates 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/signaling/turn


Methods

GET

Retrieves TURN configuration. [tags: DMA]

Request

Response

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

Note: The API client must provide the "plcm-turn-config" 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-turn-config" 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
conference templates on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator

PUT


Update current TURN configuration.
DMA role required: administrator.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-turn-config+xml
application/vnd.plcm.plcm-turn-config+json

Response

Status Representation Description
204
TURN config updated successfully. The ETag returned in the HTTP header represents the version
of the current configuration.
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
Unauthorized. DMA role required: administrator
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
TURN Configuration cannot be null.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid turn-port number. Must be between 1024 and 65535.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid relay-port-range-start number. Must be between 1024 and 65535 and come before the relay-port-range-stop value.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid relay-port-range-stop number. Must be between 1024 and 65535 and come after the relay-port-range-start value.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid transport. Must be either TCP or UDP
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid realm. Cannot be null or empty
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid public-ip-address. Cannot be null or empty
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid public-nat-address. Cannot be null or empty
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid turn-user-list. Cannot be null or empty

https://localhost:8443/api/rest/signaling/turn/status


Methods

GET

Retrieves current TURN status. [tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-turn-status+xml
application/vnd.plcm.plcm-turn-status+json
Information successfully retrieved
304
Default TURN status information has not changed since the last search.

Note: The API client must provide the "plcm-turn-status" 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-turn-status" 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
conference templates 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/signaling/webrtc


Methods

GET

Retrieves WebRTC configuration. [tags: DMA]

Request

Query Parameters

Name Type Description
clusterName xs:string
Specifies the clusterName from which the config should be retrieved. If not provided, the name of the cluster handling the REST request is assumed.
clusterIdentifier xs:string
Specifies the clusterIdentifier from which the config should be retrieved. If not provided, the identifier of the cluster handling the REST request is assumed.

Response

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

Note: The API client must provide the "plcm-webrtc-config" 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-webrtc-config" 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
conference templates on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Specified cluster does not exist

PUT


Update current WebRTC configuration.
DMA role required: administrator.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-webrtc-config+xml
application/vnd.plcm.plcm-webrtc-config+json

Response

Status Representation Description
204
WebRTC config updated successfully. The ETag returned in the HTTP header represents the version
of the current configuration.
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
Unauthorized. DMA role required: administrator
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
WebRTC Configuration cannot be null.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The request contained ETags in both the header and the body, and they do not match.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Signaling type is either not provided, or does not match the content type. The acceptable values are sip, gatekeeper, or webrtc.

https://localhost:8443/api/rest/signaling/webrtc/default


Methods

GET

Retrieves default WebRTC configuration. [tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-webrtc-config+xml
application/vnd.plcm.plcm-webrtc-config+json
Information successfully retrieved
304
Default WebRTC information has not changed since the last search.

Note: The API client must provide the "plcm-webrtc-config" 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-webrtc-config" 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
conference templates 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/signaling/poly-evo


Methods

GET

Retrieves Poly EVO configuration. [tags: DMA]

Request

Query Parameters

Name Type Description
clusterName xs:string
Specifies the clusterName from which the config should be retrieved. If not provided, the name of the cluster handling the REST request is assumed.
clusterIdentifier xs:string
Specifies the clusterIdentifier from which the config should be retrieved. If not provided, the identifier of the cluster handling the REST request is assumed.

Response

Status Representation Description
200 application/vnd.plcm.plcm-poly-evo-config+xml
application/vnd.plcm.plcm-poly-evo-config+json
Information successfully retrieved
304
Poly EVO information has not changed since the last search.

Note: The API client must provide the "plcm-poly-evo-config" 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-poly-evo-config" 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
conference templates on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Specified cluster does not exist

PUT


Update current Poly EVO configuration.
DMA role required: administrator.
Note: gk-port-from and gk-port-to fileds are read only fields so both values will be ignore in case of PUT request.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-poly-evo-config+xml
application/vnd.plcm.plcm-poly-evo-config+json

Response

Status Representation Description
204
Poly EVO config updated successfully. The ETag returned in the HTTP header represents the version
of the current configuration.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Bad request
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unauthorized. DMA role required: administrator
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Poly EVO Configuration cannot be null.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid port number. Must be between 1024 and 65535.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The request contained ETags in both the header and the body, and they do not match.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
acl-id for listening point is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
registration-policy-id for listening point is required.

https://localhost:8443/api/rest/signaling/poly-evo/default


Methods

GET

Retrieves default Poly EVO configuration. [tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-poly-evo-config+xml
application/vnd.plcm.plcm-poly-evo-config+json
Information successfully retrieved
304
Default Poly EVO SVC information has not changed since the last search.

Note: The API client must provide the "plcm-poly-evo-config" 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-poly-evo-config" 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
conference templates 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/signaling/acl


https://localhost:8443/api/rest/signaling/acl/variables


Methods

GET

Retrieves ACL variables. [tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-acl-variable-list+xml
application/vnd.plcm.plcm-acl-variable-list+json
Information successfully retrieved
304
ACL Variables have not changed since the last search.

403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator

PUT


Update current ACL Variables.
DMA role required: administrator.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-acl-variable-list+xml
application/vnd.plcm.plcm-acl-variable-list+json

Response

Status Representation Description
204
SIP config updated successfully. The ETag returned in the HTTP header represents the version
of the current configuration.
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
Unauthorized. DMA role required: administrator
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
SIP Configuration cannot be null.

https://localhost:8443/api/rest/signaling/restore-default


Methods

POST

Restoring default signaling configuration. [tags: DMA]

Response

Status Representation Description
204 Signaling configuration restored to default values successfully.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unauthorized. DMA role required: administrator

https://localhost:8443/api/rest/signaling/status


Methods

GET

Retrieves current signaling status for the H.323 Gatekeeper, SIP service and WebRTC service. [tags: DMA]

Request

Query Parameters

Name Type Description
clusterName xs:string
Specifies the clusterName from which the status should be retrieved. If not provided, the name of the cluster handling the REST request is assumed.
clusterIdentifier xs:string
Specifies the clusterIdentifier from which the status should be retrieved. If not provided, the identifier of the cluster handling the REST request is assumed.

Response

Status Representation Description
200 application/vnd.plcm.plcm-signaling-status+xml
application/vnd.plcm.plcm-signaling-status+json
Information successfully retrieved
304
status information has not changed since the last request.

Note: The API client must provide the "plcm-signaling-status" 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-signaling-status" 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
conference templates on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Specified cluster does not exist