resources

Remove Resource

Remove a resource from the graph.

Only available for DRAFT, WAITING, and FAILED resources that never provisioned anything. Everything else, including a resource whose provisioned infrastructure outlived an upstream deactivation, must use deactivate first. Resources it owns alone are removed with it.

Removal is a lifecycle phase, not an erasure: the resource comes back with lifecycle_state: "deleted" and its name stays taken while it holds that state. Once its retention window passes the record is archived, and reading it then answers 404: there is no such resource in Pragmatiks any more.

The response lists the resources the removal 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 removal that would be refused is refused the same way in a dry run.

Sensitive fields are masked by default in the response.

Returns: The resource in its deleted state with the removal’s predicted impact list. A dry run returns the resource unchanged.

Raises: HTTPException: 404 if resource not found.

DELETE

projects

{project_id}

resources

by-name

Remove Resource

curl --request DELETE \
  --url https://api.example.com/projects/{project_id}/resources/by-name

const options = {method: 'DELETE'};

fetch('https://api.example.com/projects/{project_id}/resources/by-name', 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/by-name",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
]);

$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/by-name"

	req, _ := http.NewRequest("DELETE", 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/by-name")

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

request = Net::HTTP::Delete.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 removal 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

Remove Resource

curl --request DELETE \
  --url https://api.example.com/projects/{project_id}/resources/by-name

const options = {method: 'DELETE'};

fetch('https://api.example.com/projects/{project_id}/resources/by-name', 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/by-name",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
]);

$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/by-name"

	req, _ := http.NewRequest("DELETE", 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/by-name")

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

request = Net::HTTP::Delete.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

Remove Resource

Path Parameters

Query Parameters

Response