Skip to main content
POST
/
resources
/
{name}
/
apply
Applies a resource plan
curl --request POST \
  --url https://use.hoop.dev/api/resources/{name}/apply \
  --header 'Content-Type: application/json' \
  --data '
{
  "sid": "5701046A-7B7A-4A78-ABB0-A24C95E6FE54",
  "resource_name": "my-postgres"
}
'
{
  "message": "failed obtaining blob stream: empty blob stream",
  "resource_name": "my-postgres",
  "sid": "5701046A-7B7A-4A78-ABB0-A24C95E6FE54",
  "status": "success"
}

Documentation Index

Fetch the complete documentation index at: https://mintlify.hoop.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
name
string
required

The resource name

Body

application/json

The request body

​
sid
string<uuid>
required

The Session ID of the plan to apply

Example:

"5701046A-7B7A-4A78-ABB0-A24C95E6FE54"

​
resource_name
string

The resource name to apply to. Required for batch requests.

Example:

"my-postgres"

Response

OK

​
message
string

Error message populated when status is "failed"; empty on success

Example:

"failed obtaining blob stream: empty blob stream"

​
resource_name
string

The resource name this apply result is for

Example:

"my-postgres"

​
sid
string<uuid>

The session ID for tracking and auditing this apply execution

Example:

"5701046A-7B7A-4A78-ABB0-A24C95E6FE54"

​
status
enum<string>

Status of the apply execution

Available options:
success,
failed
Example:

"success"