Delete a instance configuration

DELETE /platform/configuration/instances/{id}

Delete the instance configuration with the given id.

Path parameters

  • id string Required

    ID of the instance configuration

Query parameters

  • version integer

    This is a database-level field, not related to the application-level 'config_version', except as described in the following docs. If specified, checks for conflicts against 'x-cloud-resource-version' from the GET request (the GET's 'config_version' should be left blank if the IC is configuration controlled, ie to get the latest configuration)

Responses

  • Instance configuration specified by {id} was deleted

    Additional properties are allowed.

  • Instance configuration specified by {id} is system owned (code: 'configuration.system_owned')

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

  • Instance configuration specified by {id} cannot be found or the operation failed (code: 'configuration.instance_configuration_not_found')

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

DELETE /platform/configuration/instances/{id}
curl \
 -X DELETE https://{{hostname}}/api/v1/platform/configuration/instances/{id}
Response examples (200)
{}
Response examples (403)
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (404)
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}