Skip to content
forgit api docs

Delete an organization Copilot Space

DELETE
/orgs/{org}/copilot-spaces/{space_number}

Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.

Warning: This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.

Organization members with appropriate permissions can delete Copilot Spaces owned by their organization.

OAuth app tokens and personal access tokens (classic) need both the read:org and repo scopes to use this endpoint.

Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
org
required
string

The organization name. The name is not case sensitive.

space_number
required
integer

The unique identifier of the Copilot Space.

Responses

Section titled “ Responses ”

204

Section titled “ 204 ”

The Copilot Space has been successfully deleted.

404

Section titled “ 404 ”

Resource not found

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

422

Section titled “ 422 ”

Validation failed, or the endpoint has been spammed.

Media type application/json
Validation Error

Validation Error

object
message
required
string
documentation_url
required
string
errors
Array<object>
object
resource
string
field
string
message
string
code
required
string
index
integer
value
One of:
string
nullable
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "errors": [
    {
      "resource": "example",
      "field": "example",
      "message": "example",
      "code": "example",
      "index": 1,
      "value": [
        "example"
      ]
    }
  ]
}