Patch Service By Id

Patch Service By Id

Patch an existing service by providing a JSON patch document in the request body. This is used primarily to provide regular heartbeats from a service to the Service Registry to keep the service discoverable.

Request
URI
PATCH
https://{api_host}/dms/service/v0alpha1/services/{service_id}
COPY
Path Parameters
string
service_id
Required

ID of the service to be patched. It is the name associated with the service.


Request Body

Patch document consisting of the operation, path and value to be updated.

Array of JsonPatchDocument of type(s) application/json
Optional
[
    {
        "op": "string",
        "path": "/status",
        "value": "REGISTERED"
    }
]
Responses
204

Successfully patched the object entry.

Operation doesn't return any data structure

400

Bad request due to errors in request body or in json patch document.

Returns ProblemDetails of type(s) application/problem+json
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


404

Service identified by service_id not found.

Returns ProblemDetails of type(s) application/problem+json
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.