Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
outlinetrue

The following document describes the v2 api for the scheduler.

Tip
For the V1 API, please refer to MultiCloud K8s-Plugin-service API

Projects API

Projects are new concept that has been introduced in the v2 api. They allow multi-tenancy in the application from a user perspective.

POST

Code Block
languagebash
titlePOST
linenumberstrue
POST
URL: /v2/project
POST BODY:
{
  name: "Name of Project" //must be unique
}

RETURN STATUS: 201
RETURN BODY: 
{
  name: "name of the project"
}

GET, DELETE


Code Block
languagebash
titleGET, DELETE
linenumberstrue
GET
URL: /v2/project/{project-name}

RETURN STATUS: 200
RETURN BODY: {
  name: "Name of Project" //must be unique
}

DELETE
URL: /v2/project/{project-name}

RETURN STATUS: 204

Resource Bundle API

The resource bundle API is now keyed off the Project API

Code Block
languagejs
linenumberstrue
{
    "rb-name": "test-rbdef",
    "rb-version": "v1",
    "chart-name": "vault-consul-dev", //optional field. chart-name will be detected if this is not provided.
    "description": "testing resource bundle definition api",
    "labels": {
    }
}