Create an app API Reference

POST

/tenants/{tenant}/apps

curl --request POST \
  --url https://api.kupe.cloud/api/v1/tenants/example/apps \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "deletionProtection": true, "name": "shop" }'

Create an app with deletion protection on by default. Answers 404 while the platform has apps switched off.

Authorizations

• BearerAuth

Parameters

Path Parameters

tenant

required

string

Tenant name

Request Body

Request

Media type application/json

object

deletionProtection

Must be false before the app can be deleted. Defaults to true.

boolean

name

App name, an RFC 1123 label of at most 32 characters without –.

string

Example

shop

Responses

201

Created

Media type application/json

object

createdAt

string

deletionProtection

boolean

generation

integer

name

string

resourceVersion

string

status

object

conditions

Array<object>

object

lastTransitionTime

string

message

string

reason

string

status

string

type

string

environments

Array<object>

object

address

string

name

string

phase

string

phase

string

uid

string

Example ^generated

{
  "createdAt": "example",
  "deletionProtection": true,
  "generation": 1,
  "name": "example",
  "resourceVersion": "example",
  "status": {
    "conditions": [
      {
        "lastTransitionTime": "example",
        "message": "example",
        "reason": "example",
        "status": "example",
        "type": "example"
      }
    ],
    "environments": [
      {
        "address": "example",
        "name": "example",
        "phase": "example"
      }
    ],
    "phase": "example"
  },
  "uid": "example"
}

Headers

ETag

string

UID and spec generation

400

Bad Request

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

401

Unauthorized

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

403

Forbidden

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

404

Not Found

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

409

Conflict

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

412

Precondition Failed

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

429

Too Many Requests

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

500

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}