--- id: scope-update title: "Update a scope" description: "Updates information for a scope." sidebar_label: "Update a scope" hide_title: true hide_table_of_contents: true api: eJztW/1uI7cRfxWC//TOWOkk+eMcAQmg87mp0+v54I8miG3I1O5IYr1LbkiufYohoH/0/75Dn6J9nb5AX6GY4a6Wqw9bSS5tUyQIjD2KHA6H8/Gbmd1HnoCNjcyd1Ir3+WWeCAeWSTXWJhM4ysbaMMFsrHNo84jrHAz9cJLwPqfhfkHLeMQtxIWRbsb7V498BMKAGRRuyvtXN/ObiDsxsbx/xc9xFb+JeC6MyMCBsbRCIg+5cFMecSUy4H0uEyQbTyETvP/I3SynUeVgAobPI27gu0IaSHjfmQKipQNdTIGdvGV6zNwU6kPAR5HlKfB+t7e7h5whFbDujU5muE2slQPl8FHkeSpjOvGrP1kk+rjKjx79CWLHI54blI+TYGmeE66gp8WGXMRO3qOsyqXWGakmfB3jfvkq86rIUIo5qESqyVDkudH3IsXty6Gp1nfBP6sZwwSUhKT+hUc8NiCcfzQQ/GPBJ12uH6sewy0TSMFVJ0jBEfmxkCk9WKfz3P9KjzQYCxVDihNQJ6QjuZBOnHuBzRcXAsnQ5hA3RPjIM8i0mQ2lGk5GvN+LeJwXw9zosUy9SIVKhMGtUh2LdGidNmIC1YLDebRycU3pv4WxVGBJ7g7iqZKxSBlyIselMlgyDDeV1t8Me/Eg05SNgBnIUxFDwkYzFotcjGQqUSNetlcUpHmQhTqpIhuBIa7GokgdnXFx/t46XRGZLpRDXfE0mUjx7A4S5nTAZsQyELYwkDCp2EROxGiGFv/iyzcv2yj4higfV7S0Ur5AxmiMyqKy3ARchjM2C/fowyUrd1uSJzGz9vo+jZiINCtJM3EvZCpGKfwgac2X1PesUtpz1Fn6FUzT/GWWa+OEcs96gIYOSjAMp290Bg5saYVKq2FspEOVxdsJNlwML9vdhfTONFTXde5tcQ5VpOkmhjUNiJSNQbjCgGW2iKdMWJbqyUSqScRE4TSzsUj9v1TCbK4dkwqVJgbbZucAdNCrkKWbF68SHdtXdHr7qmFcLNFxkYFyddRKwAmZWtIkYS24oQ8qq1q9qig4sxI2rW2EDZ4JqVo0jsQzsFZM1ousSXqQJLKUjp1ZBxmr1jIDaW2u5Q3/xi6CgGGxVmM5KXz0bS/fxhwN0YtvKJPtDllHxmop7Q4mk0o4aLMBBj+8UpXOKsZuF9vcyTS9ZRgolvjhstURGFr3D14fftYZ4SPKKdEot+d5GygWhN3Wg0yAFUp+VwDzJEpfsS6i85FMUa1aIpet3OikjdIReW7bUiMTlQ48feee8LW6Vl+wf/7lH//6+1/Zzs577aC/s8OOpkKhIjcuilbv7CQaLFPasRgneSW2aTHZ2YnYtUIrSDQutZrFukgTNjIg7vByFcQ+sDxIN2XwUZJFh5Kw3lTA3Es0kmu1xonUgvggZmgPlg0+nJANJDJDR63V07b9yEHdS6NVRhAIQ1ZSEGtEZK3Nm0I5mUFTR1m9YbTwAQFtVGoDE6lVxNxUODrqrOmBifEyQoRsC2PEDN2bg8yuatQ8OM9VeJ5hcJqb5dO8P3tfRSOLbKzhJ2JSJYDwCXwcWXty2wwOtHJYouT5fE74xuZaWX+mXqezXiMXYJs9CHKjMVg7LlLU+B+NUWvEfOXhNVlEqUkRR2UluEZQbGG0UbgLepibZTDjvU4DWkfLgH3F0ks32LDxk7fL9h2Yba3fb7yho3qvsYNMfHwHaoLJR7fTec7F1/v8rIHCkwsPERfW6WydHZeBfTHhAUbDXOs0eBzeHVrKusw9mBSsXVXpEEXcSZUgqx6vznTBCO9vcnPX6gsa/vPf2M7OYALKtUYivoPEE7DoCS8tsFvP4i0aiidY5YssE0pMPBKe6cL4MIPInwmk125s8Q4mIp4FxMkC3LSEPpYJA9eKMZ0mYCKWG0jocCU/5SRyJN5CGeIA+ZHA29gI60wRIyBZtVVS5XuZLKO1z+BwT+zHu62DuAetvXF3v/VZZ9RpdeOD1+Nk9/X4AA5D/MnxlMOK1pCsa9PFrpn65enpl++O+18fvxl+OD191//y98c84oNvL8+CwcHvz3nET49O6qFTP+/r83romGY1h456J+/PLwbvj46r386Pz/54fPbu+Py8/27whzdvB6sKdIKOTo5lqUMVw17OuX4AY0N3vVGV2LO6hNe9s3N5efJ2Z6dhl83EK1DcpM0ucGtcwyRCKFcYVIiHKfh5XkOYYAoe1hLDgCpiZzE0kYouDnjy9hn1PFULww90cbHeX7jXrl8LAT+6EEDhqCG4AOA1/fxB5zlhPgEscZ81YaeGrFsizE/H0XqoO18JxCFviLmfDbpN6B9Q80atH5RdRmC/lmN+Lcf88ssxz5U3fkH1jP+RksMvrcAFHx0YJdJhCSAC8Y20TkGoFTZPVII+BiyiCo9GF8AEszIK+JjkQsIq8umszW7HIrVw67FIOGk0Yyi9PBUOuywRu8XOxS2T4wrWBHTYC2hP2hG7l4JdgDECl3jX4Lspj2GiW6Z2dphAnmpK/3nEp3IyHeZGamrN3ETb59BLFismiJOsjiVxSXWKZmj672TqGLWywjp09xTOVt3stln7L7hKUlIfNs+0xU0E3bT6Kih9RzixIvuztbLbyBsbCQuUi0lng8MG8Godk0tODEfx4nyuWWKjddoYZCJfsBNX5gRYOWOQ5W7GaAM0NqVXqBnK4eVELTlFX2pbltt2FZUNdZLnUf8mXBiURxr8NwsP8PpQdJJet7Ub7x22Xu/1uq3Dbpy0ep3dMRzujQ5h73VYV/lhlY4nNha5bMdmljvdkipuxzoLKx/PbxNGgXX06UIoM4AUYqfN8yGQcqhy9mbZNW9Jm4lQ8vsQZT/Pe7gIE8gG410St9mi/o2k0MPpMcPk282ahMJdPu/2RRwjivq818cbsrmI4fPdfqA9n1Px3Rchtz2JN92Tt96sV+RlMd1eMr720nGp6D9vZL8/NNUN7r+EAYtstEpcGyC3/HVeZrOQDIXbshVyfto6POh02eXFEUP3Zp3IcuSD4veKACj0V1UITHTpfQne51jjbSGBhjB6nd5+q9NtdXoXnU6f/v8W2fQ14Z+ZzVRYx8qdtua1t8Trcjn7LdE/K8vY9PsP6j8NKncmqwJTbZpVnFx0pZ5w803f0x314t1krwX744MW9p5aYhQnLRjX3ajlDPpHlnqfzZqjNaXqc9+6IRZIVUOgtsaNUWFhhCQ2vdxCdzuWSqTye0hYTW4pf4sQRtwivdsy9gVTp8KyEYBisUaGSU3QhgpjEIh9IlZLcukM71ehODZyS9tLhRBwYsDan7T3gIp/wV41I5KQOW2xIiAFZelO53aDfS7vu9awtjbi0oIXuIkeppAUqUcjyMkKl66e01624oNWZ6/V6TY9jtN3oIZjbYapVHdbeOUB++rrC0bL6JYmoKgpha3Jwk3ReH1hw3NNVNvsFDvGuQFbXW4YtMoW521JCobeWQ1pk1sGCoVa6uCTfvynCTz0mnU+Fzj1n+q/fw72lp35Mo8Hre7+RbfX313wmIETiXBre4GrzFSzWapFAgklni4cj4UTqZ74rnIjIbqDGe/ze5EWUOaCAZ6iH7fxsncwq5xstWfznEhpHpX7bEWSpj5JtCxniEWtZNjkfusSy0JM9XpMPuO0SKjrT11Z38fH/H0Vd5Yzns2I8FxfnZ++X5Bcc7wNCcs8KB48vcemhH+LTba8/+2vtZ5Zapj/r4YlfyiZOtJZrhWGihXQUjbf9775ZrXffpRK9FVgDCXcZXueJQUVIaW6F6nEumNeUEqeSWvxRutXWD9ZU95j4COdEC5Dfvii4LeaTgazV1P65Rv93cXFhwpjxzqh6rh30ovXWcqqOotDeZRVqL1OB/908c8u/tl72TCjvU4HfXaTl41xJRPxVCpoGRAJFXv9XsQXYSqMKxNt5PdlldA3uhk2lQqz/NqPSIZll4IKGSS2LZgYGQnjiE2LTKiak2BWZVieOcpOS2lc8zciYWWV+ZrjwKXCmEgsJ9f85RIKrGcHJdwtmKzdS1kCZmKkC1ez1dwHXUMpCgoZmUgxEmERhkq6TlCnslLpUIMrm9pfZyHnXvzLFiJ9gZQAgWLSWvS1PmwNPpwwKxP4PzMNGwqiVIZ9NI39Tg//7DYvfv+/ZxV4WKp3+0lDL7L/mH2clNuzUnWOcY63lDIVYpdq0exZMZi1y39W0xkoVij4mENMZXg6ko4pYUja7EMKwgJz2M+bYHaN7RPTrkNRBm6qE/8RQ4xfMdDHDH3uOzyvHmUyX7yv4z95KEzK+3zqXG77r15h7SzsDfjq2U39YcU5WolX7vDzioUYkFD1wQR5RZrEo/LhtxUg/errC4qOaH1n9bcPxzWYq4o2dcVltQf8KRq/1EBqNnEaXTr/pnH4Vlb4TlXYCPMzG0WItS+i1k395zr55X7NFymXOwRPtQHqdsjm1gZlumONpFArvN522512h9fo5X2gFPTCGxLX1mWCnGfJqP98p3r7atkYgs9atvnQp9QoBx/dqzxFeWG+g+r6WKr1Fa/26fv3AafaOhx+fMSa/6VJ53Mc/q4Ag58E3SC6M9JnzFePPJGWEj3ep1bZE+y+OCtjwEu24YuetdxW4FYhtC2BJedRmajIhM9R+lMQ9OLXVZXBHPl9Wxf+hchq4UrUmkfVikEcQ+6enHsTeIcPg4uj36FRlp8bZRQauBEPaGbiwXPp+86kYzT2yFOhJgX5Pe6JogmLpgdYsng61lo5PD76GReYdM/nC7FQEo6Smc//DQ8/y60= 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"; Updates information for a scope. ℹ️ **Note:** Changing the scope's name **does not change the slug**, \n as doing so could break connections with existing applications and services.\n","type":"string","example":"Payments API."},"dimensions":{"type":"object","example":{"environment":"production"},"description":"Defines runtime configuration dimensions, such as environment or region, that apply to this scope."},"profiles":{"type":"array","items":{"type":"string"},"example":["environment_production"],"description":"NRN profiles to apply to this scope, independent of runtime configurations."}},"title":"scope_update"}}}}} > ℹ️ **Note:**\n>\n> • **Agent-backed scopes:** Use `custom` to create a scope managed by your installed agent.\n>\n> • **Legacy scopes:** The other types are\n older, predefined scope types that depend on fixed infrastructure configurations."},"provider":{"example":"9e84a5c3-6c2e-4f15-90b0-1c67fd37f6e8","default":"your_provider_id","type":"string","enum":["your_provider_id","GOOGLE:WEB_POOL:GKE","AZURE:WEB_POOL:AKS","OCI:WEB_POOL:OKE","AWS:WEB_POOL:EKS","AWS:WEB_POOL:EC2INSTANCES","AWS:SERVERLESS:LAMBDA"],"description":"Identifies the provider that powers this scope.\n\n> ℹ️ **Note:**\n> \n> • **Agent-backed scopes:** The **UUID** of the scope specification you created. This UUID is returned when you define a new scope specification and acts as your provider ID.\n>\n> • **Legacy scopes:** One of the predefined provider strings."},"status":{"example":"active","type":"string","description":"The status of the scope.","enum":["pending_approval","pending_hook","pending_approval_denied","pending","creating","recreating","active","updating","updating_approval","deleting","deleted","failed","stopping","stopped","cancelled"],"title":"ScopeStatus"},"slug":{"example":"billing-api","maxLength":60,"type":"string","description":"An application-wide unique slug for the scope."},"domain":{"example":"billing-api-prod.nullapps.io","maxLength":60,"type":"string","description":"An application-wide unique domain for the scope."},"application_id":{"example":2345,"type":"integer","description":"The ID of the application that owns this scope."},"requested_spec":{"example":{"memory_in_gb":2,"cpu_profile":"standard","local_storage_in_gb":8},"type":"object","description":"Defines the technical specifications for this scope (will be replaced by capabilities).","properties":{"memory_in_gb":{"type":"number","default":2,"example":2,"description":"The amount of memory allocated to this scope, measured in gigabytes (GB)."},"cpu_profile":{"type":"string","enum":["standard","intensive"],"example":"standard","description":"Defines the CPU profile for this scope."},"local_storage_in_gb":{"type":"number","default":2,"example":2,"description":"The amount of local storage available to this scope, measured in gigabytes (GB)."}},"title":"ScopeRequestedSpec"},"capabilities":{"type":"object","description":"Defines optional features such as logging, auto scaling, and spot instances. See the [capabilities](/docs/scopes/capabilities) documentation for details."},"messages":{"type":"object","description":"Additional system messages related to the scope's status or configuration.","example":null},"tier":{"example":"important","type":"string","description":"Defines the tier type of the scope.","enum":["testing","non_critical","important","critical"],"title":"ScopeTier"},"external_created":{"type":"boolean","description":"Indicates whether the scope was provisioned externally. `false` when provisioned by nullplatform, `true` if created externally (e.g., via Terraform)."},"tags":{"example":["requires_deployment","high_priority"],"type":"array","items":{"type":"string"},"description":"Tags associated with the scope."},"profiles":{"type":"array","items":{"type":"string"},"example":["environment_production"],"description":"NRN profiles that must be applied to this scope, independent of runtime configurations."},"dimensions":{"type":"object","example":{"environment":"production"},"description":"Defines runtime configuration dimensions, such as environment or region, that apply to this scope."},"runtime_configurations":{"type":"array","items":{"type":"integer"},"example":[1234,2345],"description":"Runtime configurations that apply to this scope based on its dimensions."},"domains":{"type":"array","description":"Array of custom domains associated with this scope.\n> It returns an empty array if no custom domains are assigned to the scope.\n","items":{"type":"object","required":["id","name","type"],"properties":{"id":{"type":"string","description":"The application-wide unique ID for the custom domain.","example":"e78a0d21-3c48-7421-81cd-203fe84b8e47"},"name":{"type":"string","description":"The name of the custom domain.","example":"api.crypto-inc.com"},"type":{"type":"string","description":"The type of the domain.","example":"scope"},"selector":{"type":"object","description":"The selector for the custom domain.","properties":{"organization_id":{"type":"string","description":"The organization ID.","example":"1"},"nrn":{"type":"string","description":"The NRN of entity.","example":"organization=1:account=2:namespace=3:application=4"},"scope_id":{"type":"string","description":"The scope ID that the custom domains is associated with..","example":"1234"}}},"status":{"type":"string","description":"The status of the domain.","enum":["active","pending"],"example":"active"},"created_at":{"type":"string","description":"The ISO-8601 UTC timestamp of when the custom domain was created.","format":"date-time","example":"2025-01-02T00:00:00Z"},"updated_at":{"type":"string","description":"The ISO-8601 UTC timestamp of when the custom domain was last updated.","format":"date-time","example":"2025-02-02T00:00:00Z"}},"title":"scopeDomainResponse"}},"instance_id":{"type":"string","description":"A unique identifier for the runtime instance associated with this scope.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"application_name":{"type":"string","description":"The name of the application that owns this scope.","example":"Billing Service"},"active_deployment":{"type":"object","nullable":true,"description":"The last finalized deployment for this scope, or `null` if no deployment has been completed."},"current_active_deployment":{"type":"object","nullable":true,"description":"The currently running deployment for this scope."},"in_progress_deployment":{"type":"object","nullable":true,"description":"A new deployment currently in progress, or `null` if none."},"stops_at":{"type":"string","nullable":true,"format":"date-time","description":"The ISO-8601 UTC timestamp when this scope is scheduled to stop, or `null` if not scheduled.","example":"2026-04-01T00:00:00Z"},"token_for_links":{"type":"string","description":"A JWT token for generating authenticated scope links. Only present for organizations with `generate_domain_token` enabled."},"created_at":{"type":"string","format":"date-time","description":"The ISO-8601 UTC timestamp of when the scope was created.","example":"2025-01-02T00:00:00Z"},"updated_at":{"type":"string","format":"date-time","description":"The ISO-8601 UTC timestamp of when the scope was last updated.","example":"2025-06-15T12:30:00Z"},"metadata":{"type":"object","description":"The metadata loaded via the metadata catalog API.","example":{"key":"value"},"properties":{"key":{"type":"string","description":"The key of the metadata.","example":"key"},"value":{"type":"string","description":"The value of the metadata.","example":null},"additional_properties":{"type":"object","description":"Additional metadata properties, including schemas and tags.","properties":{"schemas":{"type":"array","description":"The JSON schemas of the metadata.","items":{"type":"object"}},"tags":{"type":"array","description":"Tags associated with the metadata.","items":{"type":"object","properties":{"key":{"type":"string","example":"key"},"value":{"type":"string","example":"value"}}}}}}},"title":"MetadataComponent"}},"title":"scope"}}}},"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."}}}}}}}} >