/user/api/v1/serviceInstances/{id} (PATCH) - BlueCat Edge - Service Point v4.x.x

BlueCat Edge User Guide
Locale
English
Product name
BlueCat Edge
Version
Service Point v4.x.x

Update the service deployed to a Service Point v4 instance.

Request: PATCH https://<us|eu>.fleet.bluec.at/user/api/v1/serviceInstances/{id}
Authorization: Bearer token
Content-Type: Application/JSON
{
    "version": "2.1.0",
    "ingressEndpoints": [],
    "parameters": [
        {
            "name": "DNSForwarderType",
            "value": "DoT"
        },
        {
            "name": "EventHubName",
            "value": "testLab"
        },
        {
            "name": "EventHubConsumerGroup",
            "value": "alpha"
        },
        {
            "name": "EventHubPartitionId",
            "value": "0"
        },
        {
            "name": "EventHubConnectionString",
            "value": "Endpoint=sb://NamespaceName.servicebus.windows.net/;SharedAccessKeyName=KeyName;SharedAccessKey=KeyValue"
        },
        {
            "name": "UmbrellaOrganizationID",
            "value": 0
        }
    ]
}

Path parameter

Name Description Type Required/Optional
id The service instance ID Integer Required
Body parameters
  • version—the version of the service that you would like the update the service to.
  • ingressEndpoints—information about the ingress endpoints of the service. If you would like to update an ingress endpoint to be internal, include the associated port label with an empty list of addresses. If you are modifying other components of the service point and you would like to leave the endpoint unmodified, do not include the port label and IP addresses in the request body.

    The ingress endpoints include the following fields:

    • portLabel—the label for the ingress endpoint. If required by the service, the port label can be one of the following:
      • dns—the endpoint will be used for DNS service.
      • status-service—the endpoint will be used for health and diagnostics.
    • addresses—the service IP addresses of the service point that bind to the ingress endpoint
      Note: If you would like the service to default to listen on all primary addresses of the service point, configure the portLabel parameter with the name of the service and do not specify the addresses parameter.
  • parameters—the deployment parameters. The additional parameters include the following:
    • name—the name of the parameter.
    • value—the value of the parameter.

Successful response

202 Accepted
Possible error codes
  • 400 Failed to parse the request body
  • 404 Service instance not found
  • 409 Service instance update is already queued
  • 500 Internal Server Error