Modify Service

Description

Modify a Nabto Edge Service.

Request

POST /v1/n5/services/:serviceId

{
  name?: string|null,
  httpUrl?: string|null,
  httpUser?: string|null,
  httpPass?: string|null,
  tags?: {
    [key: string]: string
  }
}

Response

Successful response contains the following JSON formated body:

{
   serviceId: string,
  organizationId: string,
  name: string|null,
  httpUrl: string|null,
  httpUser: string|null,
  httpPass: string|null,
  tags: {
    [key: string]: string
  },
  created: string
}

Response Status codes:

200 on success

Request headers

This request must have the following headers:

Authorization: bearer <ApiKey>
X-Nabto-Organization: <organizationId>
Content-Type: application/json

Example

Request

curl -XPOST "https://api.cloud.nabto.com/v1/n5/services/:serviceId" \
  -H "Authorization: Bearer <ApiKey>" \
  -H "X-Nabto-Organization: <OrganizationId>" \
  -H "Content-Type: application/json" \
  -d '{ "name": "friendly name", "httpUrl": "<httpUrl>", "httpUser": "<httpUser>", "httpPass": "<httpPass>", "tags": {"foo": "bar" }}'

Response

{
   "serviceId": "se-xyabzwcd",
  "organizationId": "or-lmnopqrs",
  "name": "friendly name",
  "httpUrl": "<httpUrl>",
  "httpUser": "<httpUser>",
  "httpPass": "<httpPass>",
  "tags": {
    "foo": "bar" 
  },
  "created": "2022-10-18T10:17:24.299Z"
}