Delete a project

Request infrastructure deletion and remove the project from customer inventories. Its operation history remains available so you can check whether deletion finished. While a restore, import or move runs on one of its databases, the request is refused with HTTP 409 workload_busy and nothing is deleted.

DELETE/api/customer/v1/projects/{projectId}

Permission: projects:delete
Operation ID: deleteProject

This operation can remove, overwrite or interrupt resources, or grant access. Check the project and resource IDs before sending it.

Send an Idempotency-Key header. Keep the same value when retrying this exact request. A different payload needs a new key.

Path parameters

Name	Value
`projectId`	Required resource ID from an earlier API response.

Example request

Set HCODE_BASE_URL and HCODE_API_KEY as shown in Getting started. Replace resource variables with your own IDs.

Set REQUEST_ID to a unique value for this request.

curl --request DELETE "$HCODE_BASE_URL/api/customer/v1/projects/${PROJECT_ID}" \
  --header "Authorization: Bearer $HCODE_API_KEY" \
  --header "Idempotency-Key: $REQUEST_ID"

Response

The JSON shape is defined in the response schema.

Queued work returns HTTP 202 with an operation handle. Poll that handle to find out whether the work succeeded.

Response schema

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "message": {
      "type": "string"
    },
    "operationId": {
      "type": "string"
    },
    "operation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "operationId": {
          "type": "string"
        },
        "status": {
          "type": "string"
        },
        "errorMessage": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "createdAt": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "startedAt": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "finishedAt": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "id",
        "status"
      ],
      "additionalProperties": true
    },
    "deploymentId": {
      "type": "string"
    },
    "projectId": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "operations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "href": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "status",
          "href"
        ]
      }
    }
  },
  "required": [],
  "additionalProperties": true
}

See errors and retries for failure responses.