Delete Circuit

DELETE 
/api/v1/circuit/:circuit_id/delete

Delete a circuit.

Request

Path Parameters

circuit_id stringrequired
The circuit identifer of the circuit. This can take one of the following forms:
1. <CIRCUIT_ID> - The unique UUID4 ID for an exact version of a compiled circuit.
2. <CIRCUIT_NAME> - The name of a circuit owned by the authenticated team. This will default to the most recent version of the circuit tagged as latest.
3. <CIRCUIT_NAME>:<TAG> - The name of a circuit owned by the authenticated team and an explicit tag. This corresponds to the most recent compilation of the circuit with the specified tag.
4. <TEAM_NAME>/<CIRCUIT_NAME> - The name of a circuit owned by the specified team. This will default to the most recent version of the circuit tagged as latest.
5. <TEAM_NAME>/<CIRCUIT_NAME>:<TAG> - The name of a circuit owned by a specified team and an explicit tag. This corresponds to the most recent compilation of the team's circuit with the specified tag.

Responses

200

OK

application/json

Schema

Schema

success Success (boolean)

Default value: true

Example (from schema)

{
  "success": true
}

404

Not Found

application/json

Schema

Schema

error Error (string)required
circuit_idobject

required

anyOf

MOD1

string

MOD2

string

message Message (string)required

Example (from schema)

{
  "error": "string",
  "circuit_id": "string",
  "message": "string"
}

500

Internal Server Error

application/json

Schema

Schema

error Error (string)required
message Message (string)

Default value: An internal error occurred.

Example (from schema)

{
  "error": "string",
  "message": "An internal error occurred."
}

Loading...