Modify handle service
Allows to update a registered handle service.
This operation requires handle_service_update privilege or
oz_handle_services_update admin privilege.
Example cURL requests
Modify handle service password
curl -u username:password -X PATCH -H "Content-type: application/json" \
-d '{"name": "New handle service name"}' \
https://$ZONE_HOST/api/v3/onezone/handle_services/$HANDLE_SERVICE_ID
Path parameters
| Parameter | Type & Description |
|---|---|
| id required | string Handle service Id. |
Request body
The user defined name of the service.
The endpoint of the Handle service proxy, i.e. a service which implements logic specific for particular Handle service.
serviceProperties An abstract type for Handle identifier services properties.
An abstract type for Handle identifier services properties.
The type of handle service.
The type of handle service.
Request Examples
{
"proxyEndpoint": "https://newendpointdomain.com:17000/handle_proxy"
}Responses
Update was successful.
Invalid request.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Authentication error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Authorization error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Resource not found.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Internal server Error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}