---
id: service-specification-read
title: "Read a service specification"
description: "Read a service specification"
sidebar_label: "Read a service specification"
hide_title: true
hide_table_of_contents: true
api: eJztWW1vGzcS/isEcUCTu5VsB3cfboFDocZqqsaVDMtOiqqqQ+2OtGx2yQ3JtbMV9N8PQ+4LV1pFdhGgX+ovlvgyM5x5ZuYhtaUyB8UMl2IS05BqUA88gnudQ8TXPLIzoQIW04AattE0XNC5W0SXAY1BR4rnuIqG9AZYTBiphJCOEBrQnCmWgQGFUrZURwlkjIZbarhJgYZ0YrWUOX7WRnGxoQFdS5UxQ0NaFBznuyrvBP9UAOExCMPXHBRZS0VMAgQHTEkU5Ao0CAMxYZowcnc3uaS7gHLcnjOT0IAKlqFOK1/Bp4IriGloVAG7ZUA1RIXiprRWr4ApUKPCJDRcLHFagc6l0KDxKK9+/hn/dY2crX6HyLSmcLHpd5KmAY2kMCAMSmF5nlYzZ79rFNXxmnOUtMLRvQpjabgzhMd/mWedN7cH+jIurkBs0HMXARXSnhFEkdFwIYo0Xe72bZiyDIhce1qH5KdCG7ICwoiQYgBZbkriVBAmYiKkIfCpYCkxkqBUtEinxebrWDRPi01tUSd0QzIqjMyY4RFL05JsQGBiQUzWSmbkV+uVXylaEynAiXtm+mxqohIzA7i8yOPnLH/gmq9SuDfSB8A7HOUporgBAlOKlQdxH+FoF6sPzWaiweCQ3gPDkMydM0CTx4SZs8dEkogJogGISbiu1tGAcgOZ9k2b3kx7wJkzY0ChQb9JtWGC/2Hd/L/F+eC//1z+60XIokgWwtQDL799EaKLdc4i8Ae9JPKHdSRzb90/DvwwLdI0T5lBB5Mb0LJQERCLyBfTm+nLrosYSTgopqIE47+fNcKXpSpZmu52AWXGKL4qDHR8MqpHW88cyfPj9SCGNStSBM0hin3k1nBuLCFOpp9qDyzlMflxPpuSuVOISGNpUZn9dNXv7CbCtJYRt/nxyE3SNaDSbJUyA4RtGBfakFzJBx5DXBlo/deW60Xti8ayZeOsEuOmvezuW7uXB2kqHyEmtQRi0YXnZnHMcRFLr71QrFmqYV9IX+VnwnO1PTyrDmQLmOeZyjQsYJBCZKTqgGReDZ7ECM9yqQzEXqhWUqbAhB8re4Cd3YteVqcLZsY+N9/Ozz1RlInSVjpmYCNV+RVE6WJ1/9XEHQ3iFudna9vpn6NhFzTrRZGtQFFvpPZ1ZxE2psP28hbKgY06kT3IwSRgAklDA4ddHftDe2ukx5CDiEFEWH1t2TsE+22ZN422l5kMyTyRRRpjOZAC9lpgg1XCRdUViqzilWhizDMQ2hIcH7+dKnRZrzkF5y8E78tp0JaKntAcVrO6PbYNq+Pg3XEUVaXAL03N5yVus1H4gi/mNkqn0ronUY+sPH02KeAI7GsYjd7Pw/n45t345mo8n4dXo5++uxzRwI6/H393fz2bXYXj168m0/ntaPp6PD+Ye2uHfrm7GbeDIzv4ZjZ7c+WNvnk7pgGdvZ60Q7O3Y7r0MuipLPZucolgxRIr8/07ic3AjIuJc8PFs0JaN44Tm3BWa74RzGNlR3yMxcnLluP52rIt3k1a5FzYsa1GiJEEM1FW7CsgUqQlabMxIFK5MYfIoeWbGu6rennPItNk7WHjeJJFHY8T7aoIK4ysGTLhRhPHiQPiyG5gO2EMKWD3dzY4Ht3hCbphKu8TEERm3GDblKIRh8ursxCuCd7oLCGDB1AlwSMR+BxBbsgH64EP+w4QLMMQnT6/tQDlO6VNqUbWgKpl7vBhT9ZeDlZllxwiq2YfQbSndUf8RpMPKOpDw0eqQztgEkbw2gFq0HCkWnEN2SG5dGfSCIrGEwIe9++gu4O29KwL7BcTqOUudvd874kAPrMsT207q+7kWTmoNA323xP8m86Cdm4JF8314IIGx6Ze2bzqtCYQD1xJkVUX8O5bQNsjFlhf4yKqDNGGbRAle7Xdr8/tzj9TR7G0DeR6wBofDKyaPZe4UtQtNlVN6V4znvqIkJX3rkbd16jr6YMBLnOsp29ZxYc8Dna+z9t71Cz9jrxzfwH9d9/ryve2AVgwdwAKSkmlSVzYt4HR9YRwYUDVJe05Ly0VaMco8fSNzDBT6Ncyhn4v+Lb/cHt7TdwGEskY60Zs7RAbx6OsRmTSXXFN5+h9s7G7nDznlTUowGKEtaci0VU6oGyn5KTweSKVCUhSZEwM8EkQMVbpspUUddYMHVEBWrPNE6y+BMN4CnElq9pX3fbsjampKMTG7LPpqVF/GgadG2Qbu9ov7UGWDoT/+RuEf4PwrwWhPZhJJD7Zb8C457KEhvSs9wH/bMvjHfYpUA/163uhUhrSxJhch2dnLOdDn4cMI5lR/+3bvvo4aPkv4I1XUZClq7gMaZJdRIPqw/c1Sf/x/a11Gxdry4TRHue6i+H58Jy2DKHz/ja6nmA0c6lNxoRHD0785NCJzrZNtlP7qlNhlM/ylHELUeuybeXqRf9vJTSgIY+RWCRSG1y23a6YhjuV7nY4/KkAfMBYLLG/KY7wtfGIucbPcf9Dkm/6i5sKKy/JMUvrW55t/baN0pDSgH6E0v3MYS8+CTDLThbbamIUIRX2thxUJIREg7w341tkFl0g7AXev1J2zdlu3Ypb+RHEbtdYZ/A7Grjb/R/gAlT+
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 specification"}
>
</Heading>

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



Read a service specification

<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={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"2XX":{"description":"Object representing service specifications","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,"not":{"enum":[null]},"description":"Name of the entity. Must be a non-empty string and not equal to null"},"slug":{"type":"string","minLength":1,"not":{"enum":[null]},"description":"Slug of the specification. Automatically generated from \"name\""},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"visible_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"}},"attributes":{"title":"Attribute","type":"object","properties":{"schema":{"type":"object","default":{},"description":"Specification of the attribute schema. Must be a valid JSON Schema"},"values":{"type":"object","default":{},"description":"Values associated with the attribute. Must validate against provided schema"}},"required":["schema","values"],"propertyNames":{"enum":["schema","values"],"description":"Allowed property names"},"additionalProperties":false,"description":"Object representing an attribute with a schema and associated values"},"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 specification. Should be one of the specified values in the enumeration"},"dimensions":{"title":"Specification Dimension","type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"required":{"type":"boolean"},"values":{"type":"array","items":{"type":"string"}}},"additionalProperties":false,"required":["required"]}},"scopes":{"title":"Specification Scope","type":"object","properties":{"provider":{"type":"object","properties":{"values":{"type":"array","items":{"oneOf":[{"type":"string","enum":["AWS:SERVERLESS:LAMBDA","AWS:WEB_POOL:EC2INSTANCES","AWS:WEB_POOL:EKS","AZURE:WEB_POOL:AKS","GOOGLE:WEB_POOL:GKE","OCI:WEB_POOL:OKE"]},{"type":"string","format":"uuid","description":"UUID of a scope specification"}]},"minItems":1}},"additionalProperties":false,"required":["values"]}},"additionalProperties":false},"assignable_to":{"type":"string","enum":["any","dimension","scope"],"description":"Specifies if the service can be assigned to any entity, only dimensions, or only scopes."},"use_default_actions":{"type":"boolean","description":"Specifies if the service specification should autogenerate its create, update, and delete actions from the attributes schema. When omitted on create, the default is true for every type except `scope`"},"use_default_naming":{"type":"boolean","description":"When true, the instance name is optional and generated by nullplatform or taken from the schema's `name` property. When false, a caller-provided name is required. Defaults to true for new specifications"}},"description":"Object representing service specifications","additionalProperties":false,"title":"ServiceSpecification","example":{"name":"my-service-specification","visible_to":["organization=1:account=1","organization=1:account=2"],"dimensions":{"environment":{"required":true,"values":["production","staging"]}},"scopes":{"provider":{"values":["AWS:SERVERLESS:LAMBDA","AWS:WEB_POOL:EC2INSTANCES","uuid-of-a-specific-scope-specification"]}},"assignable_to":"any","attributes":{"schema":{"type":"object","properties":{"my_string_property":{"type":"string"},"my_number_property":{"type":"number","default":0}},"required":["my_string_property"]},"values":{}}}}}}},"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>