Resources

Create, edit, and configure multiple resources.

post

The /apply route will try to parse resources and upsert them into the store.

Body

application/json

resourcesobject[]Optional

Responses

202

Accepted

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /v1/apply HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "resources": [
    {}
  ]
}

{
  "updates": [
    {
      "before": null,
      "reason": "string",
      "resource": null,
      "status": "error"
    }
  ]
}

Delete multiple resources

post

/delete endpoint will try to parse resources and delete them from the store.

Bodyobject[]

application/json

object[]Optional

Responses

202

Accepted

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /v1/delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 4

[
  {}
]

{
  "errors": [
    "text"
  ],
  "updates": [
    {
      "before": null,
      "reason": "string",
      "resource": null,
      "status": "error"
    }
  ]
}

List resources by kind

get

Path parameters

kindstringRequired

the kind of the resource

Responses

200

OK

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /v1/resources/{kind} HTTP/1.1
Host: 
Accept: */*

{
  "resources": []
}

Get a resource by kind and name

get

Path parameters

kindstringRequired

the kind of the resource

namestringRequired

the name of the resource

Responses

200

OK

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /v1/resources/{kind}/{name} HTTP/1.1
Host: 
Accept: */*

{
  "resource": null
}

Delete a resource by kind and name

delete

Path parameters

kindstringRequired

the kind of the resource

namestringRequired

the name of the resource

Responses

204

Successful Delete, no content

No content

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /v1/resources/{kind}/{name} HTTP/1.1
Host: 
Accept: */*

No content

Server version

get

Returns the current bindplane version of the server.

Responses

200

OK

application/json

Responsestring

get

HTTPcURLJavaScriptPython

GET /v1/version HTTP/1.1
Host: 
Accept: */*

200

OK

text

Get the history of a resource

get

Path parameters

kindstringRequired

the kind of the resource

namestringRequired

the name of the resource

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /v1/{kind}/{name}/history HTTP/1.1
Host: 
Accept: */*

{
  "versions": [
    {}
  ]
}