Endpoints Settings Controller Resource

The API allows you to view and edit endpoints settings.

DELETE /endpoints-settings

Clear endpoints settings.

Example

Request
DELETE /endpoints-settings
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /endpoints-settings

Returns endpoints settings details.

Response Body
media type data type description
application/json EndpointsSettingsDetails (JSON) endpoints settings details

Example

Request
GET /endpoints-settings
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "username" : "...",
  "url" : "...",
  "isEndpointsEnabled" : true,
  "connectionSuccessful" : true
}
                
              

PUT /endpoints-settings

Change endpoints settings details.

Request Body
media type data type description
application/json EndpointsSettingsRequest (JSON) specify endpoints settings details to update
Response Body
media type data type description
application/json EndpointsSettingsDetails (JSON) updated details of endpoints settings

Example

Request
PUT /endpoints-settings
Content-Type: application/json
Accept: application/json

                
{
  "username" : "...",
  "password" : "...",
  "url" : "...",
  "isEndpointsEnabled" : true,
  "connectionSuccessful" : true
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "username" : "...",
  "url" : "...",
  "isEndpointsEnabled" : true,
  "connectionSuccessful" : true
}
                
              

GET /endpoints-settings/info

Returns endpoints settings details.

Response Body
media type data type description
application/json EndpointsInfo (JSON) endpoints settings details

Example

Request
GET /endpoints-settings/info
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "url" : "...",
  "isEndpointsEnabled" : true
}
                
              

PUT /endpoints-settings/password

Change endpoints password.

Request Body
media type data type description
application/json StringDTO (JSON) specify new password

Example

Request
PUT /endpoints-settings/password
Content-Type: application/json

                
{
  "value" : "..."
}
                
              
Response
HTTP/1.1 204 No Content