---
id: scope-type-create
title: Create a scope type
description: Enable scope types for your applications.
sidebar_label: Create a scope type
hide_title: true
hide_table_of_contents: true
api: >-
  eJztWNtuG0cS/ZVCPyXEiKJuTjKAHxTLwSoLOIZFIQEkwSl2FzltzXRPuntIM8QAedj3/Yf9is3v5AfyC0F1D6khpViO94rAL9QM2ZdTVeecLvVKKPLS6Tpoa0QunhuclARe2pogLGvyMLUOlrZxgHVdaok80g9FJmxNLr6dK5GLOGWPp+TSEQYSmQg48yK/Eheb5cRNJjzJxumwFPnVSkwIHbnTJhQiv7ppbzLh6IeGfPjSqqXIV0JaE8gEfuwB2H/jGe9KeFlQhfxUOwYUNHl+My7+HPfMhQ9Om5nIdqJ98eoFfIIBrIMJlXbxKSwKcgSh6KcgBU4xZnqLVV3yktbN0OgfI5qnBzlKaRsTnh7mBivyNUp6epT3ED89Fm3W4bmPi0xTcaZk44OtOEvbSM9oqg35iOxWGwV22iFc2gZSwofX5tr88reff/3n32EweGED5YPBtfnlp3/AYHA6IxP2JihvSaWZPh8M4NITfJ82/R6C7VYC7Bav0OCMFEyWiQLa+IBlSQqQ1xsCXBuAcaE96ATOkbRVRUbxGKOgsj7AtKS3mnllYzyRUoYWHY7tvHYZaDPBiXy8huOCQGlfl7gEngG+sAvDsSiaU8mc8PymFZmgp8ud4m5v/vyvF/DMWfO1nTCCrZ0eA3JRWBeg9x3XqLCLXTYtrLv1TLlFgQF0AGV3c3BGdWmXUJPTVmkJb+zEgzZw20zIGQrkGZ0PGBr/LjahDHrOQtSme7xHrG8LCgU5CFzDHkrtgaIXKE7ehKDxpLZRdku2GUtvrhW514/R25Oba/kAjD6/vW2cJOByBS4XZ4m3rMgE/87yrZfvQ9LqIUBT6yoMIhdNo9WDnDo/4/rxbuulEpTaLiKjNvn6ENnxBoPB5eX52WCw3iYF5WuSetp5Rk/cqq81nsgVchQaZ0ixbaXBKuYR8E5eOyuyJlEGD+iTpDfRnZ9tJ/ML+vwYT+TR3hN5SHvH04OTvS9Gk9HegXzy2VQdfTZ9Qp+Llj1Nhzghuvx4WdOr5OCibflnR762xidbPhyN+M/9dG8OE1igB99ISd5Pm5IxfeARsFV501QTco9U+nd4dXB4dHzChvSvnin/f+cKxx+xbM6T+6r6EEeOTtzZcrIQjv0djhxBJD19dOSPjvzRkf/Njpw8uLPk4+++u+/Cz0pNJgA5Zx1sTBtUQ1GsZo6lVqBN3URzq7T32sygRocVBXL+D1l1V347eUMyiNT1a0cqcjLK6JlVLJSIR2SiIu9xFom6bfO90XfrahNo9oDf/2U8fglpBkiruF+tHXlmtpmlonfFAdnPxyc0nA0zOB6N+OOAP4744/jTrRIdj0YtJ0G9h02eQoWy0Ib2HKGK/3alvSKuyGyJgWbW6R/XOiQ3JwdT1GXjdpQ2QfXarQ/eddreA8TEaZpmUDQVmjskO6bJmydw0Yq6bFyLL1FBd9pfC/7i0mATighZXYvt5PRHM8R1RR8HqZTmRyxBUUBdesCJbcIdrO19xvH/kLhP7CYqLNldSEHMrgmoWaJrSvcZ3LZJIScPKeQipX9XIdqoyHMzAzSgvW8IrIngTl+eg9eK/mTS8P1EdGQ4YWmcjA7542i78Cf/O1VwsM5g+ToNep1S9l/Tx3m3PXTUec5jklIu0skIlwbnqEte9Z5gHpz+H5XOqYHG0NuaZCDVhWSlbJzj8+5lSegJglsCzlAbKDGQW6sm4gqF5dug2nqmbo18ryP247mXepFMpFL4eP3TuFLkogih9vn+PtZ6aJqyrEsMrNih5L6zd2V0wSJJ3O5fHG2ywAvxDnEYm2IcJLLu4at1j/H1t+N4ULL4Xt3dNz1f56G7P/qQZnzdi6/b5nXXvNXJ3m+2Hm0v77rLuyZyp8vbdFs7zdZ7Ng7clE4tB8/lScAOhqPhSNx1FC961WF3i42d9aHCaGJdqM+2b5G6uu/07hs//EOXjl2kgd6G/bpEbRhBZNGqY9uV6LHtJhMFUzG/EqvVBD1durJt+esfGnJ8BXmTiTk6zQjiDWQmCkJFLtLzlpYcTkK6N05xzLFsYre96+Jttp5xKiXV4Z1jb3pqefnNxZhJ2l15VtEphcMFuz8uRC7idWtMAg+I361EiWbWRBsQaU2mNG4rYkcBMaruJzTLHsLVKo0Y21sybSuyLpTA76K9adv2NyK2tK4=
sidebar_class_name: post api-method
info_path: docs/api/nullplatform-api
custom_edit_url: null
canonical: 'https://docs.nullplatform.com/docs/api/scope-type-create'
---
<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create a scope type"}
>
</Heading>

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

</MethodEndpoint>

Enable scope types for your applications.

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

<ParamsDetails
  parameters={undefined}
>

</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>