> For the complete documentation index, see [llms.txt](https://docs.idlayr.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.idlayr.com/api-reference/management/projects.md).
# Projects
Create, read, and update projects within a workspace.
## List projects
> Returns a page of the projects in the workspace.
```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"tags":[{"name":"projects_v1","description":"Create, read, and update projects within a workspace."}],"servers":[{"url":"https://{data_residency}.api.idlayr.com","description":"For accounts with data residency in the EU or US.","variables":{"data_residency":{"default":"eu","enum":["eu","us"]}}}],"security":[{"WorkspaceBearerAuth":[]}],"components":{"securitySchemes":{"WorkspaceBearerAuth":{"description":"Management endpoints expect an [OAuth2 Access Token](https://tools.ietf.org/html/rfc6749#section-1.4)\nin the `Authorization` HTTP header, e.g. `Authorization: Bearer {access_token}`.\n\nThe token must be obtained with **workspace credentials** and carry the `management`\nscope. This is distinct from the project `client_id` / `client_secret` credentials used\nto call the product APIs.\n","type":"http","scheme":"bearer"}},"parameters":{"pageSize":{"name":"size","description":"The number of items returned per page.","in":"query","schema":{"type":"integer","default":10,"minimum":1,"maximum":100}},"pageNumber":{"name":"page","description":"The page number being requested.","in":"query","schema":{"type":"integer","default":1,"minimum":1}},"Search":{"name":"search","in":"query","required":false,"description":"An [RSQL](https://github.com/jirutka/rsql-parser) filter over the projects collection.\nFilterable fields: `name`, `mode`, `description`, `rate_limit`, `created_at`, `updated_at`.\nExample: `name==Production`.\n","schema":{"type":"string"}}},"schemas":{"ProjectList":{"description":"A page of projects.","type":"object","unevaluatedProperties":false,"required":["content","page"],"properties":{"content":{"description":"Projects in the current page.","type":"array","items":{"description":"A project.","$ref":"#/components/schemas/Project"}},"page":{"$ref":"#/components/schemas/page"}}},"Project":{"description":"A project — the unit a product is pointed at within a workspace.","type":"object","unevaluatedProperties":false,"required":["project_id","name","mode","created_at","updated_at"],"properties":{"project_id":{"$ref":"#/components/schemas/UUID"},"name":{"description":"Human-readable project name.","type":"string"},"mode":{"$ref":"#/components/schemas/ProjectMode"},"description":{"description":"Optional free-text description of the project.","type":"string"},"rate_limit":{"description":"The per-project request rate limit, in requests per second.","type":"integer"},"configuration":{"description":"Per-product settings for the project.","$ref":"#/components/schemas/ProjectConfiguration"},"created_at":{"description":"When the project was created.","$ref":"#/components/schemas/ISODateTime"},"updated_at":{"description":"When the project was last updated.","$ref":"#/components/schemas/ISODateTime"}}},"UUID":{"description":"A Universally Unique IDentifier.","type":"string","format":"uuid","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"},"ProjectMode":{"description":"The project's mode:\n- `live`: production traffic, billed.\n- `sandbox`: test traffic against sandbox numbers.\n- `disabled`: the project is disabled and rejects product traffic.\n","type":"string","enum":["live","sandbox","disabled"]},"ProjectConfiguration":{"description":"Per-product settings for the project. Each block is optional and present only when the\ncorresponding product is configured.\n","type":"object","unevaluatedProperties":false,"properties":{"secure_sna":{"description":"Secure SNA callback and redirect URLs.","$ref":"#/components/schemas/CallbackRedirectConfig"},"reverse_sms":{"description":"Reverse SMS settings.","$ref":"#/components/schemas/ReverseSmsConfig"},"discovery":{"description":"Discovery callback and redirect URLs.","$ref":"#/components/schemas/CallbackRedirectConfig"}}},"CallbackRedirectConfig":{"description":"Callback and redirect URLs for a product.","type":"object","unevaluatedProperties":false,"properties":{"callback_url":{"description":"URL the platform calls with the terminal result of a check.","type":"string","format":"uri"},"redirect_url":{"description":"URL the device is redirected to at the end of the verification flow.","type":"string","format":"uri"}}},"ReverseSmsConfig":{"description":"Settings for the Reverse SMS product.","type":"object","unevaluatedProperties":false,"properties":{"callback_url":{"description":"URL the platform calls with the terminal result of a check.","type":"string","format":"uri"},"custom_message_body":{"description":"Custom body for the SMS the device is asked to send.","type":"string"}}},"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"},"page":{"description":"Pagination metadata.","type":"object","unevaluatedProperties":false,"required":["size","number","total_pages","total_elements"],"properties":{"size":{"description":"The number of records per page.","type":"integer"},"number":{"description":"The current page number.","type":"integer"},"total_pages":{"description":"The total number of pages available.","type":"integer"},"total_elements":{"description":"The total number of records across all pages.","type":"integer"}}},"Problem":{"description":"An [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807) problem detail.","type":"object","unevaluatedProperties":false,"required":["type","title","status","detail","error_code"],"properties":{"type":{"description":"A URI reference [RFC 3986] that identifies the problem type.","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"error_code":{"description":"Machine-readable error code identifying the problem type.","type":"string"}}},"RateLimitReached":{"description":"The API rate limit for the workspace has been exceeded. The `Retry-After` header carries\nthe number of seconds after which the caller can retry.\n","type":"object","unevaluatedProperties":false,"required":["type","title","status","detail","error_code"],"properties":{"type":{"description":"A URI reference [RFC 3986] that identifies the problem type.","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"error_code":{"description":"Machine-readable error code identifying the problem type.","type":"string"}}}},"responses":{"Unauthorized":{"description":"The Access Token is missing, invalid, or lacks the `management` scope.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"Forbidden":{"description":"The caller is authenticated but not permitted to perform this operation.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"WorkspaceNotFound":{"description":"The workspace identified by `workspace_id` does not exist or is not visible to the caller.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"RateLimitReached":{"description":"The API rate limit for the workspace has been exceeded.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/RateLimitReached"}}}}}},"paths":{"/v1/workspaces/{workspace_id}/projects":{"get":{"summary":"List projects","description":"Returns a page of the projects in the workspace.","operationId":"list-projects-v1","tags":["projects_v1"],"parameters":[{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/Search"}],"responses":{"200":{"description":"A page of projects.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/WorkspaceNotFound"},"429":{"$ref":"#/components/responses/RateLimitReached"}}}}}}
```
## Create a project
> Creates a project in the workspace and provisions an initial set of client credentials,\
> returned embedded under \`credentials\`.
```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"tags":[{"name":"projects_v1","description":"Create, read, and update projects within a workspace."}],"servers":[{"url":"https://{data_residency}.api.idlayr.com","description":"For accounts with data residency in the EU or US.","variables":{"data_residency":{"default":"eu","enum":["eu","us"]}}}],"security":[{"WorkspaceBearerAuth":[]}],"components":{"securitySchemes":{"WorkspaceBearerAuth":{"description":"Management endpoints expect an [OAuth2 Access Token](https://tools.ietf.org/html/rfc6749#section-1.4)\nin the `Authorization` HTTP header, e.g. `Authorization: Bearer {access_token}`.\n\nThe token must be obtained with **workspace credentials** and carry the `management`\nscope. This is distinct from the project `client_id` / `client_secret` credentials used\nto call the product APIs.\n","type":"http","scheme":"bearer"}},"schemas":{"ProjectCreate":{"description":"The payload to create a project.","type":"object","unevaluatedProperties":false,"required":["name"],"properties":{"name":{"description":"Human-readable project name.","type":"string"},"mode":{"$ref":"#/components/schemas/ProjectMode"},"description":{"description":"Optional free-text description of the project.","type":"string"},"configuration":{"description":"Per-product settings for the project.","$ref":"#/components/schemas/ProjectConfiguration"}}},"ProjectMode":{"description":"The project's mode:\n- `live`: production traffic, billed.\n- `sandbox`: test traffic against sandbox numbers.\n- `disabled`: the project is disabled and rejects product traffic.\n","type":"string","enum":["live","sandbox","disabled"]},"ProjectConfiguration":{"description":"Per-product settings for the project. Each block is optional and present only when the\ncorresponding product is configured.\n","type":"object","unevaluatedProperties":false,"properties":{"secure_sna":{"description":"Secure SNA callback and redirect URLs.","$ref":"#/components/schemas/CallbackRedirectConfig"},"reverse_sms":{"description":"Reverse SMS settings.","$ref":"#/components/schemas/ReverseSmsConfig"},"discovery":{"description":"Discovery callback and redirect URLs.","$ref":"#/components/schemas/CallbackRedirectConfig"}}},"CallbackRedirectConfig":{"description":"Callback and redirect URLs for a product.","type":"object","unevaluatedProperties":false,"properties":{"callback_url":{"description":"URL the platform calls with the terminal result of a check.","type":"string","format":"uri"},"redirect_url":{"description":"URL the device is redirected to at the end of the verification flow.","type":"string","format":"uri"}}},"ReverseSmsConfig":{"description":"Settings for the Reverse SMS product.","type":"object","unevaluatedProperties":false,"properties":{"callback_url":{"description":"URL the platform calls with the terminal result of a check.","type":"string","format":"uri"},"custom_message_body":{"description":"Custom body for the SMS the device is asked to send.","type":"string"}}},"ProjectWithCredentials":{"description":"A project together with the initial credentials provisioned for it.","type":"object","unevaluatedProperties":false,"required":["project_id","name","mode","created_at","updated_at","credentials"],"properties":{"project_id":{"description":"The unique ID of the project.","$ref":"#/components/schemas/UUID"},"name":{"description":"Human-readable project name.","type":"string"},"mode":{"description":"The project's mode.","$ref":"#/components/schemas/ProjectMode"},"description":{"description":"Optional free-text description of the project.","type":"string"},"rate_limit":{"description":"The per-project request rate limit, in requests per second.","type":"integer"},"configuration":{"description":"Per-product settings for the project.","$ref":"#/components/schemas/ProjectConfiguration"},"created_at":{"description":"When the project was created.","$ref":"#/components/schemas/ISODateTime"},"updated_at":{"description":"When the project was last updated.","$ref":"#/components/schemas/ISODateTime"},"credentials":{"description":"The credentials provisioned with the project. Includes the one-time `client_secret`.","$ref":"#/components/schemas/CredentialWithSecret"}}},"UUID":{"description":"A Universally Unique IDentifier.","type":"string","format":"uuid","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"},"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"},"CredentialWithSecret":{"description":"A newly created credential, including the one-time `client_secret`.","type":"object","unevaluatedProperties":false,"required":["client_id","client_secret","scopes","created_at","updated_at"],"properties":{"client_id":{"$ref":"#/components/schemas/UUID"},"client_secret":{"description":"The OAuth2 client secret. Returned only on creation and never again.","type":"string"},"scopes":{"description":"The OAuth2 scopes granted to the credential.","type":"array","items":{"type":"string"}},"created_at":{"$ref":"#/components/schemas/ISODateTime"},"updated_at":{"$ref":"#/components/schemas/ISODateTime"}}},"Problem":{"description":"An [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807) problem detail.","type":"object","unevaluatedProperties":false,"required":["type","title","status","detail","error_code"],"properties":{"type":{"description":"A URI reference [RFC 3986] that identifies the problem type.","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"error_code":{"description":"Machine-readable error code identifying the problem type.","type":"string"}}},"RateLimitReached":{"description":"The API rate limit for the workspace has been exceeded. The `Retry-After` header carries\nthe number of seconds after which the caller can retry.\n","type":"object","unevaluatedProperties":false,"required":["type","title","status","detail","error_code"],"properties":{"type":{"description":"A URI reference [RFC 3986] that identifies the problem type.","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"error_code":{"description":"Machine-readable error code identifying the problem type.","type":"string"}}}},"responses":{"BadRequest":{"description":"The request body or patch document is invalid.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"Unauthorized":{"description":"The Access Token is missing, invalid, or lacks the `management` scope.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"Forbidden":{"description":"The caller is authenticated but not permitted to perform this operation.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"RateLimitReached":{"description":"The API rate limit for the workspace has been exceeded.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/RateLimitReached"}}}}}},"paths":{"/v1/workspaces/{workspace_id}/projects":{"post":{"summary":"Create a project","description":"Creates a project in the workspace and provisions an initial set of client credentials,\nreturned embedded under `credentials`.\n","operationId":"create-project-v1","tags":["projects_v1"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectCreate"}}}},"responses":{"201":{"description":"The created project, with its initial credentials.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectWithCredentials"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimitReached"}}}}}}
```
## Get a project
> Returns the project identified by \`project\_id\`.
```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"tags":[{"name":"projects_v1","description":"Create, read, and update projects within a workspace."}],"servers":[{"url":"https://{data_residency}.api.idlayr.com","description":"For accounts with data residency in the EU or US.","variables":{"data_residency":{"default":"eu","enum":["eu","us"]}}}],"security":[{"WorkspaceBearerAuth":[]}],"components":{"securitySchemes":{"WorkspaceBearerAuth":{"description":"Management endpoints expect an [OAuth2 Access Token](https://tools.ietf.org/html/rfc6749#section-1.4)\nin the `Authorization` HTTP header, e.g. `Authorization: Bearer {access_token}`.\n\nThe token must be obtained with **workspace credentials** and carry the `management`\nscope. This is distinct from the project `client_id` / `client_secret` credentials used\nto call the product APIs.\n","type":"http","scheme":"bearer"}},"schemas":{"Project":{"description":"A project — the unit a product is pointed at within a workspace.","type":"object","unevaluatedProperties":false,"required":["project_id","name","mode","created_at","updated_at"],"properties":{"project_id":{"$ref":"#/components/schemas/UUID"},"name":{"description":"Human-readable project name.","type":"string"},"mode":{"$ref":"#/components/schemas/ProjectMode"},"description":{"description":"Optional free-text description of the project.","type":"string"},"rate_limit":{"description":"The per-project request rate limit, in requests per second.","type":"integer"},"configuration":{"description":"Per-product settings for the project.","$ref":"#/components/schemas/ProjectConfiguration"},"created_at":{"description":"When the project was created.","$ref":"#/components/schemas/ISODateTime"},"updated_at":{"description":"When the project was last updated.","$ref":"#/components/schemas/ISODateTime"}}},"UUID":{"description":"A Universally Unique IDentifier.","type":"string","format":"uuid","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"},"ProjectMode":{"description":"The project's mode:\n- `live`: production traffic, billed.\n- `sandbox`: test traffic against sandbox numbers.\n- `disabled`: the project is disabled and rejects product traffic.\n","type":"string","enum":["live","sandbox","disabled"]},"ProjectConfiguration":{"description":"Per-product settings for the project. Each block is optional and present only when the\ncorresponding product is configured.\n","type":"object","unevaluatedProperties":false,"properties":{"secure_sna":{"description":"Secure SNA callback and redirect URLs.","$ref":"#/components/schemas/CallbackRedirectConfig"},"reverse_sms":{"description":"Reverse SMS settings.","$ref":"#/components/schemas/ReverseSmsConfig"},"discovery":{"description":"Discovery callback and redirect URLs.","$ref":"#/components/schemas/CallbackRedirectConfig"}}},"CallbackRedirectConfig":{"description":"Callback and redirect URLs for a product.","type":"object","unevaluatedProperties":false,"properties":{"callback_url":{"description":"URL the platform calls with the terminal result of a check.","type":"string","format":"uri"},"redirect_url":{"description":"URL the device is redirected to at the end of the verification flow.","type":"string","format":"uri"}}},"ReverseSmsConfig":{"description":"Settings for the Reverse SMS product.","type":"object","unevaluatedProperties":false,"properties":{"callback_url":{"description":"URL the platform calls with the terminal result of a check.","type":"string","format":"uri"},"custom_message_body":{"description":"Custom body for the SMS the device is asked to send.","type":"string"}}},"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"},"Problem":{"description":"An [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807) problem detail.","type":"object","unevaluatedProperties":false,"required":["type","title","status","detail","error_code"],"properties":{"type":{"description":"A URI reference [RFC 3986] that identifies the problem type.","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"error_code":{"description":"Machine-readable error code identifying the problem type.","type":"string"}}},"RateLimitReached":{"description":"The API rate limit for the workspace has been exceeded. The `Retry-After` header carries\nthe number of seconds after which the caller can retry.\n","type":"object","unevaluatedProperties":false,"required":["type","title","status","detail","error_code"],"properties":{"type":{"description":"A URI reference [RFC 3986] that identifies the problem type.","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"error_code":{"description":"Machine-readable error code identifying the problem type.","type":"string"}}}},"responses":{"Unauthorized":{"description":"The Access Token is missing, invalid, or lacks the `management` scope.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"Forbidden":{"description":"The caller is authenticated but not permitted to perform this operation.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"ProjectNotFound":{"description":"The project identified by `project_id` does not exist within the workspace.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"RateLimitReached":{"description":"The API rate limit for the workspace has been exceeded.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/RateLimitReached"}}}}}},"paths":{"/v1/workspaces/{workspace_id}/projects/{project_id}":{"get":{"summary":"Get a project","description":"Returns the project identified by `project_id`.","operationId":"get-project-v1","tags":["projects_v1"],"responses":{"200":{"description":"The project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/ProjectNotFound"},"429":{"$ref":"#/components/responses/RateLimitReached"}}}}}}
```
## Update a project
> Updates the project using a \[JSON Patch]\(
> document. Mutable fields: \`name\`, \`mode\` (set to \`disabled\` to disable the project),\
> \`configuration\`, \`rate\_limit\`, \`description\`.
```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"tags":[{"name":"projects_v1","description":"Create, read, and update projects within a workspace."}],"servers":[{"url":"https://{data_residency}.api.idlayr.com","description":"For accounts with data residency in the EU or US.","variables":{"data_residency":{"default":"eu","enum":["eu","us"]}}}],"security":[{"WorkspaceBearerAuth":[]}],"components":{"securitySchemes":{"WorkspaceBearerAuth":{"description":"Management endpoints expect an [OAuth2 Access Token](https://tools.ietf.org/html/rfc6749#section-1.4)\nin the `Authorization` HTTP header, e.g. `Authorization: Bearer {access_token}`.\n\nThe token must be obtained with **workspace credentials** and carry the `management`\nscope. This is distinct from the project `client_id` / `client_secret` credentials used\nto call the product APIs.\n","type":"http","scheme":"bearer"}},"schemas":{"JsonPatch":{"description":"A [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) document — an array of operations.","type":"array","items":{"type":"object","unevaluatedProperties":false,"required":["op","path"],"properties":{"op":{"description":"The operation to perform.","type":"string","enum":["add","remove","replace","move","copy","test"]},"path":{"description":"A JSON Pointer to the target location.","type":"string"},"value":{"description":"The value to apply. Required for `add`, `replace`, and `test`."},"from":{"description":"A JSON Pointer to the source location. Required for `move` and `copy`.","type":"string"}}}},"Project":{"description":"A project — the unit a product is pointed at within a workspace.","type":"object","unevaluatedProperties":false,"required":["project_id","name","mode","created_at","updated_at"],"properties":{"project_id":{"$ref":"#/components/schemas/UUID"},"name":{"description":"Human-readable project name.","type":"string"},"mode":{"$ref":"#/components/schemas/ProjectMode"},"description":{"description":"Optional free-text description of the project.","type":"string"},"rate_limit":{"description":"The per-project request rate limit, in requests per second.","type":"integer"},"configuration":{"description":"Per-product settings for the project.","$ref":"#/components/schemas/ProjectConfiguration"},"created_at":{"description":"When the project was created.","$ref":"#/components/schemas/ISODateTime"},"updated_at":{"description":"When the project was last updated.","$ref":"#/components/schemas/ISODateTime"}}},"UUID":{"description":"A Universally Unique IDentifier.","type":"string","format":"uuid","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"},"ProjectMode":{"description":"The project's mode:\n- `live`: production traffic, billed.\n- `sandbox`: test traffic against sandbox numbers.\n- `disabled`: the project is disabled and rejects product traffic.\n","type":"string","enum":["live","sandbox","disabled"]},"ProjectConfiguration":{"description":"Per-product settings for the project. Each block is optional and present only when the\ncorresponding product is configured.\n","type":"object","unevaluatedProperties":false,"properties":{"secure_sna":{"description":"Secure SNA callback and redirect URLs.","$ref":"#/components/schemas/CallbackRedirectConfig"},"reverse_sms":{"description":"Reverse SMS settings.","$ref":"#/components/schemas/ReverseSmsConfig"},"discovery":{"description":"Discovery callback and redirect URLs.","$ref":"#/components/schemas/CallbackRedirectConfig"}}},"CallbackRedirectConfig":{"description":"Callback and redirect URLs for a product.","type":"object","unevaluatedProperties":false,"properties":{"callback_url":{"description":"URL the platform calls with the terminal result of a check.","type":"string","format":"uri"},"redirect_url":{"description":"URL the device is redirected to at the end of the verification flow.","type":"string","format":"uri"}}},"ReverseSmsConfig":{"description":"Settings for the Reverse SMS product.","type":"object","unevaluatedProperties":false,"properties":{"callback_url":{"description":"URL the platform calls with the terminal result of a check.","type":"string","format":"uri"},"custom_message_body":{"description":"Custom body for the SMS the device is asked to send.","type":"string"}}},"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"},"Problem":{"description":"An [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807) problem detail.","type":"object","unevaluatedProperties":false,"required":["type","title","status","detail","error_code"],"properties":{"type":{"description":"A URI reference [RFC 3986] that identifies the problem type.","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"error_code":{"description":"Machine-readable error code identifying the problem type.","type":"string"}}},"RateLimitReached":{"description":"The API rate limit for the workspace has been exceeded. The `Retry-After` header carries\nthe number of seconds after which the caller can retry.\n","type":"object","unevaluatedProperties":false,"required":["type","title","status","detail","error_code"],"properties":{"type":{"description":"A URI reference [RFC 3986] that identifies the problem type.","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"error_code":{"description":"Machine-readable error code identifying the problem type.","type":"string"}}}},"responses":{"BadRequest":{"description":"The request body or patch document is invalid.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"Unauthorized":{"description":"The Access Token is missing, invalid, or lacks the `management` scope.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"Forbidden":{"description":"The caller is authenticated but not permitted to perform this operation.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"ProjectNotFound":{"description":"The project identified by `project_id` does not exist within the workspace.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"RateLimitReached":{"description":"The API rate limit for the workspace has been exceeded.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/RateLimitReached"}}}}}},"paths":{"/v1/workspaces/{workspace_id}/projects/{project_id}":{"patch":{"summary":"Update a project","description":"Updates the project using a [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902)\ndocument. Mutable fields: `name`, `mode` (set to `disabled` to disable the project),\n`configuration`, `rate_limit`, `description`.\n","operationId":"update-project-v1","tags":["projects_v1"],"requestBody":{"required":true,"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/JsonPatch"}}}},"responses":{"200":{"description":"The updated project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/ProjectNotFound"},"429":{"$ref":"#/components/responses/RateLimitReached"}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.idlayr.com/api-reference/management/projects.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.