---
id: service-update
title: "Update a service"
description: "Updates a service"
sidebar_label: "Update a service"
hide_title: true
hide_table_of_contents: true
api: eJztWutvG7kR/1eIQT8k7Up+1M7dLVAUbpzDue35DNvpHaC4Ooo70vLMJTckV44q6H8/DLkr7ephx0GKpKj8Rbt8DIfz/o13DqZEy700+iKDFBzaqRSYVmXGPUICnk8cpAO4iRNwl0CGTlhZ0h5I4W1Y6Rhn9V5IwOL7Cp3/m8lmkM7Dq7SYQepthQkIoz1qT1O8LJUU4fyD3xwRnIMTORacnvysREjBjH5D4SGB0hK3XqKjWc0LbK1y3ko9gQQKqf+JeuJzSI8SKPiH5u349DQBbcLBqKsC0oGulLpbrN/pkhfIzJj5HBlqL/2sz36snGcjZJxpo3tYlH7G4pGM64xp4xm+r7hi3jCiCpEq3XvoShRyXN9zKLNwcz37aQzpYA5eekUXuMhI3muXGRtbcA8pVJWk+TXha/m+QiYz4nIs0bKxsS22mcXSokPtMWOclPT27cU5LJKl1CKrG1o9j5yzaucB3DkjJCfCnevRvQt0jk+ilprb/RjHVlfk1vIZJCA9Fu5pbSucotqm7lqTkOGoonepx6b+IdERSwk8cNv81LusNZbkyz1X0arHvFIk6ZpAVyA1+8zhFC1JNvDTZ+dxmyO1vwtb30FLBNsY7hK+JVkKT5ZT72GNfywS8LJA53lRtgjpqhih3STULG0styEnNSukUtKhMDpzsFgkLZccLFm9S4BnmSRyXF21hD/myuH6cT8FNa0MjByh0Tt7kD5fE1U813nuK/eYGkvUmdSTobAYI1A9AAmEofgY4lN85Fbkclo/Cy+nuBzELGhYqvAguBao6HnD3G8CW43g6kDWZze5qVRGXm/0MiDU1o4Zm3JVoSP5Ro+rijqUkua491aOKo9bbbt7/NlybdutghBb/CTMLfmZciUzxidcaufbi7rOyJZcsDqqkg5QofDGdtzzph5c+ecOP5RFaazHrHWrkTEKuYaWEwWTWYS9U5mhfVacPjo8bPsj1zNiW3CPE2Nnn4GUq0bDz0ZuscttOjH+GSd0onNw9dZII+vNEL6Rxf6Bs14wUWa2+CoZDjkEW5nDIgEl9T0fKRx607aOf0knR1JJP9uM32umTKPdk6bLzcyhpyG3lqb67KZ2Kscecu4PHnLDBNfMITKfS1ev62SLmrXL68stabPk3qMlhv5t7IRr+Z/gD38ZHPa+++Pdn16kXAhTad8MvPzri5TqCVdyge3BVoHSHnbClK11f9iQw2WlVKm4pyTErtGZygpkobB4cXl9+bIrIs5yiTYELcHVerrVbVq2phXjaZTLUFu9l0kjk6fzVBMrGx9w8ETqW0XJpsTFD7woFa7qUChmvVUF3NYLdKR9tBTzUUu6R5DAZpUIr74Zc3F08qp3eiJE7+TVq6z3rTg97vFvj/98cnJyyr87HcOa1w52ngfJrqnjkPw7GauYDaPlDOv4Pwt3bAZDYKFANhvGINVadrigv09TBOUMbnmBHilBDTpw4AsUyiBpe8l9Dkmj6UC/C2qognYoKqp3Atcj5BbtWUUxfXBH0xZdabSL0j3+5Rf6+TRT/Uz4KeKQLyLUrx+6OVVN/jsc3qhqss7hWeUNYRXBlZqxCWoqJDFjY2sK9i6IK8KKbUjyi2hwD2330HYPbdvQNgLWbMj9NsksjT301RY1gv345Q2g/aj1SbB9qgiallv3gj/nGDHrEgQ8cMcUd5415/TZr0TjV/aQS4XdxdKFmLnE2P9XuH6PkP7H0IAsUDtpdEcm583oln7HLjT/vC7Bx5QCK4Recmld98YrxvvsDRc5u8cZKzqlDFFtKpkQlzgrpJZFVTAVeCHbPoKPKsVXx0VS913evu6W1h4Grxn+vsu37/Lt7vJFko/Vm5ScUQvKJ8GeN1Pr7azEz5hY932br6Vvs0jgZFt34vtQYoao01FKgBuOZVVIQ2dXF0xqj5ZKNkq6z2lX1Np6UwOYx0NULDlfmwyfBhA/3N5esbiBCZORBWWBDz2JphhOpPDTJbcD2NTYNOyK9KJUxmiRnI26CnXkqXUWklQ45EniN7mxPmF5VXDds8gzspD6LB+czrJlWHsOHDtHH0rmmlaDoWLwDqlm6UoRp33wW/zyk82gjctaulvh1SVYi0Z4ujfCvRF+WSMMF/O5yWILWOSxfMwhhYM6ZxzMZbagJIB22nSsK6sghdz70qUHB7yU/XaZ1hemgHa/+IZsL5pTu2u8lCQRCnmYllFxEBZBUj9830D/v/98G0RFNn29+gLnzT7jPZbx6q5aOgfSXzSvo/5h/xBW5UOnYj+7ugj/pTDOF1y3xBq/hOp8CNWx2vkqCG39aqpWN5n8Qam4DP4abGleW90AVqtTGfoduXGeJubzEXf41qrFgobfV0hF7+AugSm3MraCBnPIpKPnbHvnq83hi+vaVV6yXbw1bQ5NZWIUcwqQwD3O4n9JQrmaIw/QYDCvJ17HM3pUQbY2boRlKn7jjjMhsPSPrr1ruerV2e3rH8g/6u/PihBPwfIHigD8IXJpSt90BcLYHBTXkypEMYhEQ9XfdcY152uX/V05zOdxxa25R71YLMXi6Z0ks1j8DtGzyIw=
sidebar_class_name: "patch api-method"
info_path: docs/api/nullplatform-api
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update a service"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/service/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Updates a service

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"schema":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"in":"path","name":"id","required":true}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"not":{"enum":[null]},"description":"Name of the entity. Must be a non-empty string and not equal to null"},"desired_specification_id":{"anyOf":[{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},{"type":"null"}],"description":"Desired unique identifier for the associated specification"},"messages":{"title":"Message","type":"array","items":{"type":"object","properties":{"level":{"type":"string","enum":["debug","info","information","warn","warning","error","fatal"],"default":"info","description":"Message severity level. Defaults to \"info\""},"message":{"type":"string","description":"The actual message content"},"timestamp":{"type":"number","description":"Timestamp of the message in milliseconds"}},"required":["message"],"additionalProperties":false,"description":"Object representing messages with severity levels"}},"status":{"type":"string","enum":["pending_create","pending","creating","updating","archiving","active","archived","failed","cancelled"],"description":"Status of the service. Should be one of the specified values in the enumeration"},"attributes":{"type":"object","description":"Attributes associated with the service, should be valid against the service specification attribute schema"},"selectors":{"title":"Selector","type":"object","properties":{"imported":{"type":"boolean","default":false},"provider":{"type":"string","minLength":1,"maxLength":100,"default":"any"},"category":{"type":"string","minLength":1,"maxLength":100,"default":"any"},"sub_category":{"type":"string","minLength":1,"maxLength":100,"default":"any"}},"additionalProperties":{"anyOf":[{"type":"string","minLength":1,"maxLength":100},{"type":"number"},{"type":"boolean"},{"type":"null"}]},"description":"Key-value object representing instance selectors"},"linkable_to":{"title":"Visibility","type":"array","description":"Array representing visibility settings for the entity. Specifies what/who can see this entity","items":{"title":"NRN","type":"string","pattern":"^organization=[0-9*]+(:account=[0-9*]+)?(:namespace=[0-9*]+)?(:application=[0-9*]+)?(:scope=[0-9*]+)?$","description":"Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources"}},"entity_nrn":{"title":"NRN","type":"string","pattern":"^organization=[0-9*]+(:account=[0-9*]+)?(:namespace=[0-9*]+)?(:application=[0-9*]+)?(:scope=[0-9*]+)?$","description":"Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources"}},"description":"Object representing service instances","additionalProperties":false,"title":"Service","example":{"name":"my-service","entity_nrn":"organization=1:account=1:namespace=1","specification_id":"67fac146-54cc-466d-8c52-a8234445a95f","linkable_to":["organization=1:account=1","organization=1:account=2"],"attributes":{"my_string_property":"my_string_value","my_number_property":0}}}}},"description":"Object representing service instances"}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"2XX":{"description":"Object representing service instances","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"name":{"type":"string","minLength":1,"maxLength":255,"not":{"enum":[null]},"description":"Name of the entity. Must be a non-empty string and not equal to null"},"slug":{"type":"string","minLength":1,"maxLength":255,"not":{"enum":[null]},"description":"Slug of the entity. Automatically generated from \"name\""},"specification_id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"desired_specification_id":{"anyOf":[{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},{"type":"null"}],"description":"Desired unique identifier for the associated specification"},"messages":{"title":"Message","type":"array","items":{"type":"object","properties":{"level":{"type":"string","enum":["debug","info","information","warn","warning","error","fatal"],"default":"info","description":"Message severity level. Defaults to \"info\""},"message":{"type":"string","description":"The actual message content"},"timestamp":{"type":"number","description":"Timestamp of the message in milliseconds"}},"required":["message"],"additionalProperties":false,"description":"Object representing messages with severity levels"}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"archived_at":{"type":"string","format":"date","nullable":true,"description":"When the instance was last archived. `null` while the instance is not archived"},"status":{"type":"string","enum":["pending_create","pending","creating","updating","archiving","active","archived","failed","cancelled"],"description":"Status of the service. Should be one of the specified values in the enumeration"},"linkable_to":{"title":"Visibility","type":"array","description":"Array representing visibility settings for the entity. Specifies what/who can see this entity","items":{"title":"NRN","type":"string","pattern":"^organization=[0-9*]+(:account=[0-9*]+)?(:namespace=[0-9*]+)?(:application=[0-9*]+)?(:scope=[0-9*]+)?$","description":"Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources"}},"dimensions":{"title":"Dimension","type":"object","additionalProperties":{"type":"string","minLength":1,"maxLength":100,"not":{"enum":[null]},"description":"Key-value pairs representing dimensions. Each key must be a non-null string with a minimum length of 1"},"description":"Object representing dimensions with key-value pairs"},"attributes":{"type":"object","description":"Attributes associated with the service, should be valid against the service specification attribute schema"},"entity_nrn":{"title":"NRN","type":"string","pattern":"^organization=[0-9*]+(:account=[0-9*]+)?(:namespace=[0-9*]+)?(:application=[0-9*]+)?(:scope=[0-9*]+)?$","description":"Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources"},"selectors":{"title":"Selector","type":"object","properties":{"imported":{"type":"boolean","default":false},"provider":{"type":"string","minLength":1,"maxLength":100,"default":"any"},"category":{"type":"string","minLength":1,"maxLength":100,"default":"any"},"sub_category":{"type":"string","minLength":1,"maxLength":100,"default":"any"}},"additionalProperties":{"anyOf":[{"type":"string","minLength":1,"maxLength":100},{"type":"number"},{"type":"boolean"},{"type":"null"}]},"description":"Key-value object representing instance selectors"},"type":{"type":"string","enum":["dependency","scope"],"description":"Type of the service. Should be one of the specified values in the enumeration"}},"description":"Object representing service instances","additionalProperties":false,"title":"Service","example":{"name":"my-service","entity_nrn":"organization=1:account=1:namespace=1","specification_id":"67fac146-54cc-466d-8c52-a8234445a95f","linkable_to":["organization=1:account=1","organization=1:account=2"],"attributes":{"my_string_property":"my_string_value","my_number_property":0}}}}}},"4XX":{"description":"Format for representing errors during API interactions","content":{"application/json":{"schema":{"title":"Error","type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code indicating the error"},"code":{"type":"string","description":"Unique error code for reference and categorization"},"error":{"type":"string","description":"Short, human-readable error type or category"},"message":{"type":"string","description":"Detailed error message providing additional context"}},"description":"Format for representing errors during API interactions","required":["statusCode","error","message"]}}}},"5XX":{"description":"Format for representing errors during API interactions","content":{"application/json":{"schema":{"title":"Error","type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code indicating the error"},"code":{"type":"string","description":"Unique error code for reference and categorization"},"error":{"type":"string","description":"Short, human-readable error type or category"},"message":{"type":"string","description":"Detailed error message providing additional context"}},"description":"Format for representing errors during API interactions","required":["statusCode","error","message"]}}}}}}
>
  
</StatusCodes>