api.md

CF K8s API Endpoint Documentation

** This document captures api endpoints currently supported by the shim**

Resources

Root

Docs: https://v3-apidocs.cloudfoundry.org/version/3.107.0/index.html#root

Resource	Endpoint
Global API Root	GET /
V3 API Root	GET /v3

Resource Matches

Docs: https://v3-apidocs.cloudfoundry.org/version/3.107.0/index.html#resource-matches

Resource	Endpoint
Create a Resource Match	POST /v3/resource_matches

Create a Resource Match

curl "http://localhost:9000/v3/resource_matches" \
  -X POST \
  -d '{}'

Apps

Docs: https://v3-apidocs.cloudfoundry.org/version/3.107.0/index.html#apps

Resource	Endpoint
Get App	GET /v3/apps/
Create App	POST /v3/apps

Creating Apps

Note : namespace needs to exist before creating the app.

curl "http://localhost:9000/v3/apps" \
  -X POST \
  -d '{"name":"my-app","relationships":{"space":{"data":{"guid":"<namespace-name>"}}}}'

Packages

Resource	Endpoint
Create Package	POST /v3/packages

Creating Packages

curl "http://localhost:9000/v3/packages" \
  -X POST \
  -d '{"type":"bits","relationships":{"app":{"data":{"guid":"<app-guid-goes-here>"}}}}'