resources

Deactivate Resource

Deactivate a resource (soft delete).

Triggers provider teardown for READY, WAITING, and FAILED resources, which return to DRAFT state once it completes. A resource that never provisioned anything returns to DRAFT immediately. Resources it owns alone are torn down with it.

The response lists the resources the deactivation reaches and what happens to each. That list is the closure the validated pre-flight walk computed, so it is a prediction rather than a record: the walk and the changes it authorises are not one transaction, and on a real call a write landing in between can still divert an individual resource. Pass dry_run=true to read the list without changing anything; a deactivation that would be refused is refused the same way in a dry run.

Sensitive fields are masked by default in the response.

Returns: Resource in DELETING state awaiting provider teardown, or in DRAFT when it held nothing to tear down, with the deactivation’s predicted impact list. A dry run returns the resource unchanged.

POST

projects

{project_id}

resources

deactivate

Deactivate Resource

curl --request POST \
  --url https://api.example.com/projects/{project_id}/resources/deactivate

const options = {method: 'POST'};

fetch('https://api.example.com/projects/{project_id}/resources/deactivate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/projects/{project_id}/resources/deactivate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/projects/{project_id}/resources/deactivate"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/projects/{project_id}/resources/deactivate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

{
  "provider": "<string>",
  "resource": "<string>",
  "name": "<string>",
  "project_id": "<string>",
  "impact": [
    {
      "id": "<string>",
      "name": "<string>",
      "provider": "<string>",
      "resource": "<string>",
      "lifecycle_state": "draft",
      "action": "teardown"
    }
  ],
  "dry_run": true,
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "config": {},
  "resolved_config": {},
  "previous_resolved_config": {},
  "dependencies": [],
  "owner_references": [],
  "outputs": {},
  "error": "<string>",
  "lifecycle_state": "draft",
  "health": "healthy",
  "health_message": "<string>",
  "pending_event_id": "<string>",
  "pending_event_type": "<string>",
  "provisioned": false,
  "reconcile_count": 0,
  "version": 0,
  "tags": [
    "<string>"
  ],
  "provider_version": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

project_id

string

required

Query Parameters

reveal

boolean

default:false

Reveal sensitive field values

dry_run

boolean

default:false

Preview the deactivation without changing anything

provider

string

required

Provider name

resource

string

required

Resource type

name

string

required

Resource name

Response

Successful Response

A deactivated or removed resource, with everything the teardown reaches.

Attributes: impact: Resources the teardown's pre-flight walk predicted it reaches. dry_run: Whether the call only previewed the teardown.

provider

string

required

resource

string

required

name

string

required

project_id

string

required

impact

TeardownImpact · object[]

required

Resources the teardown reaches, the requested one first, with the action taken on each. This is the prediction the validated pre-flight walk computed, not a record of what happened: the walk and the changes it authorises are not one transaction, so on a real call another write landing in between can still divert an individual resource. A dry run returns the same list without changing anything.

Show child attributes

dry_run

boolean

required

Whether the call only previewed the teardown, leaving everything untouched.

string

required

read-only

External resource ID for API responses: provider/resource/name.

created_at

string<date-time>

updated_at

string<date-time>

config

Config · object

resolved_config

Resolved Config · object | null

previous_resolved_config

Previous Resolved Config · object | null

dependencies

ResourceReference · object[]

Show child attributes

owner_references

OwnerReference · object[]

Show child attributes

outputs

Outputs · object

error

string | null

lifecycle_state

enum<string>

default:draft

Lifecycle states for resources.

Available options:

draft,

waiting,

pending,

processing,

ready,

failed,

deleting,

deleted

health

enum<string>

default:healthy

Available options:

healthy,

degraded

health_message

string | null

pending_event_id

string | null

pending_event_type

string | null

provisioned

boolean

default:false

reconcile_count

integer

default:0

version

integer

default:0

tags

string[] | null

provider_version

string | null

Deactivate Resource

curl --request POST \
  --url https://api.example.com/projects/{project_id}/resources/deactivate

const options = {method: 'POST'};

fetch('https://api.example.com/projects/{project_id}/resources/deactivate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/projects/{project_id}/resources/deactivate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/projects/{project_id}/resources/deactivate"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/projects/{project_id}/resources/deactivate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

{
  "provider": "<string>",
  "resource": "<string>",
  "name": "<string>",
  "project_id": "<string>",
  "impact": [
    {
      "id": "<string>",
      "name": "<string>",
      "provider": "<string>",
      "resource": "<string>",
      "lifecycle_state": "draft",
      "action": "teardown"
    }
  ],
  "dry_run": true,
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "config": {},
  "resolved_config": {},
  "previous_resolved_config": {},
  "dependencies": [],
  "owner_references": [],
  "outputs": {},
  "error": "<string>",
  "lifecycle_state": "draft",
  "health": "healthy",
  "health_message": "<string>",
  "pending_event_id": "<string>",
  "pending_event_type": "<string>",
  "provisioned": false,
  "reconcile_count": 0,
  "version": 0,
  "tags": [
    "<string>"
  ],
  "provider_version": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Overview

API Reference

api-keys

auth

canvas

events

graph

files

ops

organizations

patches

projects

providers

resources

webhooks

Deactivate Resource

Path Parameters

Query Parameters

Response