---
id: service-read
title: "Read a service"
description: "Read a service"
sidebar_label: "Read a service"
hide_title: true
hide_table_of_contents: true
api: eJztWWFvG7kR/SsDosA5vrVsp3Z6J6AtjDrXutdzAttpDrBdheKOtDxzyQ3JlaMK+u/FkFztriQ78SFFcIf4i1dccvg4fDPzyF0wU6HlXhp9lrMhc2hnUuDQIs9ZxjyfOja8Zpexmd1mLEcnrKxoBBuyC+Q5cEjDWMYqbnmJHi2NWzAnCiw5Gy6Yl14hG7KzYHde0bPzVuopy9jE2JJ7NmR1Lel9f5I3Wr6vEWSO2suJRAsTY8EXCNTg52CxsuhQe8yBO+Dw5s3ZKVtmTNLwivuCZUzzkuYM9i2+r6XFnA29rXGZ9YBGbGNjFHIdwEx4rTwbTrhy2Fh9X6Odd8xqoeocRw6FRT/i3ls5rj263mzBwvryLisUtCwH9wX6Ai14A64w9xCNQWsMZlzV6AZwNgGHnjrSArIHe8K9VArGGOzpG32j/wK7u+fG43B3Fy4iMBd8ubt7ieJV5XZ3wRqFA7hEhOsLo9Dd7uznRrh9XvvCWPnfwJd96uWehb3I0XOp3OBGs+VtxhyK2ko/DxQYI7doT2pfsOH1Lb226CqjHTpy9/Off6Z/fZe8Gv+Cwrf7KvW04RhI7TzXInhWGO1RezLAq0pJEZH94sjKlk01wS7R1BLvvYwYZP7FGBrps9iYr5T6X6in5LTDjJX8Q/Pr+fFxxrQJa0Zdl2x4rWulbpfrmM55iWAmHRQD+Kl2ntjAQRu9h2Xl5xCnBK5z0MYDvq+5ImKRVULoVD39/yC8VPV0HeFJ7U3JvRRcqTlMUVN2whwm1pRwE9x1wwKsGDVxx0dfcAdzdBTco22AuJ6/moQo+BLQVnsWt3IjeZ9G5FA/OAF3zggZNqC3PFp3ic7xaQygZnU/xbZ2idxaTllSeizdxwNR4QzVNrIlHrEcxzX9lnpi0j9yHUHK2D23zb80ylpjyb/ccxWLV0rljYG+QxJ8cDhDyl8Q8AzgNA5zFBY3YWjkYHLBNsB9w1fkS+EpstIYaFLXMmNelug8L6uOIV2XY7SbhpquTdw05qSGUiolHQqjc8eWy27duV5Bvc0Yz3NJ5rh63XH+1tK0LQ83+w730hdrrorzCotEmRH32zyzInvOPdLy6yp/SnduRSFnn9g/C9znY2JnqJRrC3xboA5+bKoK3HMHijsPzTwDeEc23sF9IRX2O0sXcmbTNeQlz33tHuNwhTqXejqKbqIYiA0seS4+Bq/Ex2g+PQsvZ8haNwR6SxUeBIFS9LwR65cBVsOaVEsHcFmYWuVUEoxeVYsU6pg3IkLqlG7qMolFWqmS+o48O/KmmwP+LZ0cS0XlfyMN9DGdUGufXLPVYNI31OTWst0AunqJ+/37woDgGhzS5kiX+vWSToJ2fnG+JftW3Hu0BOg/xk65Tvrmz9cHe9/v3n67M+RCmFr7puHZX3eGVIdcxQV2GzsSpNvshKk6/f6w4YfzWqlKcU/UhQt0prYCIdTvnfOL82d9F3EoJNqw/YKr9aytu7ZsshXDMpclaieN7vnktGltPbNKztszxROkwOHBwadJgR9xvhfIBhWX1vVX3AIfwEsuCrjDOZQ9KUNWGyUT8hKHUmpZ1iWogIW4fcg25t2W4Nrpoqm7PraQg1p5v6WmrbG81eSdchosd0IxI4WeQnHGlcyBTznlmW6nfhFu1T4kobukJEPkH2mrvxI/EJ9OIwqFN7ZH+8vUuIX1a2eDsjLWY/5pR8PKmpnM0T49SlppwvWcYAvucWrs/DOYcvV49NnMLR/OCx25+4QZekI1qJ5OS+PrTTX7SA4xW6J6VbNbOiybvX9Mb1JxRi2ongQ+b5bWq3mFn7WwVlzc8SmOLFI5/I0cJkjiJuDQAO/lLulA1Nai9moOttak0TMwtpVXqEF6kE5/45sO5L0BBPk8RU3JkHsI6YbSaTuRRWFs7mh8gRa757LfpzdTtSjNDMGbAbwN4jS4j5RT1u38jVsvHDoH6R0dSehn76ULyVPNsFOApGtBUBNd+pkJvNvi2ncEBWmKxvo68FoIxNxla3bHKEyJbrvRgDj0n0hUeeCSonulrjpHDdpEj0gHjagO8USsGyUEv6H9J9grx4UcEnY3pZi08DCjqfbCAax5mxTfr7pUe/R82NbP5sYXP/CyUiGLprvQcr7XXgh3BQnryYzDlb447MiKQ7btboe9+NOEi8OjF3vHR0LsHb14ke99J46f7/Hvnv/x6OjomH9/PGFrZ5LrB+dj2UOvnocTck/elfNRpMMoKYN5WGPTGFI5lbj5KJavTreDZfjL2NG2W84fArfCBvY2JVxbOMjrIGdPXp+B1B5tjKenXXum3XqZLkIelzrx6Po3k+PHLyL+cXX1GuIAECYnBuUBh55G/ocZScb0zT1wQZICKYyK9qJXJmiRijbFf1Iwac+C2A2TfNT4ZWGsz6CoS6736MsGMSTN5UPxtrCSR0+51jkN196YJ1vNXUwUgUGyrkIp3vd88Fvi8lfToHu/09m79t5rdekTSXj8lYRfSfhlSRgW5gtDKX2KPh5CCzZk+6li7C9kvqQSgHbWfESsrWJDVnhfueH+Pq/koHvYGwhT9r46XRLzIpm6355WfiRDQc1TNzpihE4sSw8/NBX/n2+vgqPCVfFwwQhPdNbh4GBwwNpi2DvHnrw+C6LDOF9y3SmLG99KezuwaANqs2dCTnu3XykuA/GCWxbJgdes7T2U4QKwMM7Ti8VizB2+sWq5pOb44ZL8mktHJHzgu2QX0O/rE+UD/rzD+Uc+5MZSP2SBbjNuZbxYfpIrd9KK8mfwEJDm0lTPu3OuAObx8FsgDxcN14v04kQIrHxnyEZaJtir8Pv7yysSe/3YWIuF7lm+D2exiD2uzB3q5XKFztNvArhc/g/gXlkB
sidebar_class_name: "get 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={"Read a service"}
>
</Heading>

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



Read 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},{"schema":{"type":"boolean","default":false},"in":"query","name":"include_secret_attributes","required":false,"description":"Specifies whether to show secret attributes values. If set to true, secret attributes values will be shown\n\n> **Note:** Requires the **SecOps** role. See [Roles](/docs/authorization/roles) for details.\n"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</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"},"package_revision_id":{"anyOf":[{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},{"type":"null"}],"description":"The package revision the service is currently running, or `null` when it isn't running one. The agent that applies a revision records it here"},"desired_package_revision_id":{"anyOf":[{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},{"type":"null"}],"description":"The package revision the service should move to. While it is set, the service's specification and its action specifications resolve against this revision instead of `package_revision_id`. When an action on the service succeeds, this revision becomes `package_revision_id` and this field is cleared. `null` when no move is pending"},"parent_service_id":{"anyOf":[{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},{"type":"null"}],"description":"The parent service of this service. `null` for top-level services"}},"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>