---
id: scope-type-write
title: "Update a scope type"
description: "Updates a scope type."
sidebar_label: "Update a scope type"
hide_title: true
hide_table_of_contents: true
api: eJztWN1u20YWfpWDuUoEWpb/0pZALlw7i7oLBEEsowVsIz2cORInJmfYmaEVVSDQi973HfYpdl+nL7CvsDhDSqIkr53N7raLRW4okZyf7/x83xyehVDkpdNV0NaIVFxVCgN5QPDSVgRhXtFQJMJW5JDHXCiRivhuj9+lM6cDiUQEnHqRXovL1TRxmwhPsnY6zEV6vRAZoSN3WodcpNe3zW0iKnRYUiDn4wDNCCoMuUiEwZJEKrQSifAypxJFuhBx3VT44LSZiiYRjn6stSMl0uBqSrasGecEF+dgJxBy2rKIPmBZFSTSg8Oj4xNGw2uRD19bNee9pDWBTOC/WFWFltH+/feel170QFWOvRM0eb4zzuwi3Qb2+u1reIYBrIOMCjt7DrOcHG3BhLgv+Q24wropGv1TRPPyIEUpbW3Cy8OUXeYrlPTyKO0hfnnMjmrx7OIiU5ccN1n7YEuO2SbSc5poQz4iu9NGsTNbhHNbg3SEgYY35sb89svf/v7XX2EweG0DpYPBjfnt57/AYHA6JRP2MpR3pNqZPh0M4MoT/NBu+gME2620yrsSDU5JQTbnfRxo4wMWBSlAXm8IcGMAxrn2oFtwjqQtSzKKxxgFpfUBJgV90FlBYKM9MLEODM06HJt+7TzQLHPvqRhycintqwLnwDPA53Zm2BZF91RwTni+04pM0JP5YzkoXv35Es6cNd/ajBFs7PQUkMvcugC9Zxyj3M62s2lm3Z3nlJvlGEAHUHbbB+dUFXYOFTltlZbw3mYetIG7OiNnKJBndD5gqP1j2YQy6HuWBW26vzuJ9V1OIScHgWPYQ6k9kMGMQx0sZAS1J7WJsluySZh691qRe/dUenty91o+AKOf397WThJwuAKHi73EW5Zkgn80fMvl+5C0egjQxLoSg0hFXUdte0ywlku1UCo7ixm18ten0I43GAyuri7OB4NNXfQVST3pNKNHbtXnGk/kCDkKtTOkWLbawSr6EXBNr60VmZMogwf0LaVX1l2cbzrzK/ryGE/k0d4LeUh7x5ODk72vRtlo70C++GKijr6YvKAvRcOapkOcEM+c8byit62Ci6Zp4tngK2t8K8uHoxH/7Lp7dbLBDD34WkryflIXjOkTj4CNyJu6zMg9EelHj6bk3z9T/vfOFbY/YlmdJ7us+hRFjkrcyXIrIWz7I4ocQbR8+qzInxX5syL/hxW51eBOko+//35Xhc8KTSYAOWcdrEQbVE2RrOYeC61Am6qO4lZq77WZwvrj4V+S6i78NntPMoj+F8R1R6Mzq5goEY9IREne4zQm6qbM90av19Um0PQBvf9mPH4D7QyQVnG9WjnynNlm2ga9Cw7Ivj+e0XA6TOB4NOLLAV+O+HL8fCNEx6NRw05QHyGTp1CizLWhPUeomNjdXhFXzGyJgabW6Z+WPCR3Tw4mqIvabTEtQ/XOLQ/epds+AkTmNE0SyOsSzRrJlmjy5i24KEWdN27E16igO+1vBD+4MliHPEJWN2LTOf3RDHEZ0adBKqX5LxagKKAuPGBm67CGtbnPOH6HxH1iNVFiwepCCqJ3TUDNFF2mdD+Dm6ZlyMlDDLls3b/NEG1UzHMzBTSgva8JrIngTt9cgNeK/s+o4fuO6JLhhKlxMjrky9Fm4E/+OFawsc5g8a4d9K512e/Gj4tue+hS5xWPaZly2Z6McGXwHnXBq+4Q5sHp/1XqnBqoDX2oSAZSnUlWyto5Pu/eFISeILg54BS1gQIDuSVrIq6QW9W2jyT3j2IbKRX78eCLxcj+QquGu0nRpLbjVLtCpCIPofLp/j5WemjqoqgKDMzboeTqs9fGumSqtBneb2atfMELLftVURrjIJF0f/60rDS+/W4cj0um4Nt11+nV0htdF+lTSvJlRb4snledtH49u1tyPVlkrmvMdSm5Veutaq6tkusjywcuTSeWjefwtMAOhqPhSKzrite96LDGxfLO+lBilLLO1LaJudHD3Da51977pz3PzqpAH8J+VaA2vFvMmEWXXtdinV4iEalWLIW59YHfLRYZerpyRdPw4x9rctwIvU3EPTrNvIs5qLSPxbVIJ1j47R5mH+izt50gP4fHPh8fxN09RDMXvH9R851IxB3N2zZrc9skIidU5CKs9sVZu/neuLVwOXHnHGmS5YxTKakKj4697fH1zen47BtmSNd1LaNYC4czPoBw1qJs23eRePHZQhRopnVUItEuynzCTTpu0S+a9aAfFot2xNjekWmalVsC37NnmuYftdgE+w==
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 scope type"}
>
</Heading>

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



Updates a scope type.

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

<ParamsDetails
  parameters={[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the scope type.","example":12345}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"properties":{"nrn":{"type":"string","description":"NRN (at or below) where the scope type applies.","example":"organization=1:account=2:namespace=3:application=4"},"type":{"type":"string","enum":["custom"],"description":"Defines the kind of scope you create.\n\nℹ️ **Note:**\n• **Agent-backed scopes:** Use `custom` to create a scope managed by your installed agent.  \n  This is the recommended and most flexible option for new scopes.","example":"custom"},"name":{"type":"string","description":"The display name shown to developers to identify the scope type.","example":"EKS CronJob"},"description":{"type":"string","description":"Short description of how the scope type works or what it does.","example":"Deploy periodic jobs in kubernetes"},"status":{"type":"string","enum":["active","inactive"],"description":"Whether this scope type is enabled to be used.","example":"active"},"provider_type":{"type":"string","enum":["service"],"description":"Defines the source entity that implements the scope type.","example":"service"},"provider_id":{"type":"string","format":"uuid","description":"The ID of the provider that powers this scope.\n\nℹ️ **Note:**\n• **Agent-backed scopes:** The **UUID** of the scope specification you created.  \n  This UUID is returned when you define a new scope specification and acts as your provider ID.","example":"9e84a5c3-6c2e-4f15-90b0-1c67fd37f6e8"}},"title":"ScopeTypeRequest"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The operation was successful.","content":{"application/json":{"schema":{"properties":{"id":{"type":"number","description":"The ID of the scope type.","example":12345},"nrn":{"type":"string","description":"NRN (at or below) where the the scope type applies.","example":"organization=1:account=2:namespace=3:application=4"},"type":{"type":"string","enum":["custom"],"description":"The type of scope type.","example":"custom"},"name":{"type":"string","description":"The name displayed to the developers to identify the type scope.","example":"EKS CronJob"},"description":{"type":"string","description":"Short description of how the scope type works or what it does.","example":"Deploy periodic jobs in kubernetes"},"status":{"type":"string","enum":["active","inactive"],"description":"Whether this scope type is enabled to be used.","example":"active"},"provider_type":{"type":"string","enum":["service"],"description":"Defines the source entity that implements the scope type.","example":"service"},"provider_id":{"type":"string","format":"uuid","description":"The ID of the provider that powers this scope.\n\nℹ️ **Note:**\n• **Agent-backed scopes:** The **UUID** of the scope specification you created.  \n  This UUID is returned when you define a new scope specification and acts as your provider ID.","example":"9e84a5c3-6c2e-4f15-90b0-1c67fd37f6e8"}},"title":"ScopeTypeResponse"}}}},"4XX":{"description":"Client error responses due to invalid input or missing parameters.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific client error (e.g., 400, 401, 403, 404).","example":400},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"bad_request"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Bad Request\", \"Unauthorized\").","example":"Bad Request"},"message":{"type":"string","description":"Additional details about the error.","example":"The request was malformed or contained invalid parameters."}}}}}},"5XX":{"description":"Server error responses indicating an issue on the API side.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific server error (e.g., 500, 502, 503).","example":500},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"internal_server_error"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Internal Server Error\", \"Service Unavailable\").","example":"Internal Server Error"},"message":{"type":"string","description":"Additional details about the error.","example":"An unexpected error occurred. Please try again later."}}}}}}}}
>
  
</StatusCodes>