List application profiles

GET 
/api/v1/applications/profiles

Retrieve application profiles for an organization

Request

Header Parameters

X-API-KEY stringrequired

APIKey

Responses

200

OK

application/json

Schema

Schema

data

object[]

Array [

clusterSelection

object

cloudProvider

object

cloudProvider specifies the cloud provider and region where the application will be deployed.

availabilityZones string[]

provider string

Possible values: [aws, gcp, azure, digitalocean]

+kubebuilder:validation:Required +kubebuilder:validation:XValidation:rule="oldSelf == '' || self == oldSelf",message="Provider is immutable, cannot be changed on update"

region string

+kubebuilder:validation:Required +kubebuilder:validation:XValidation:rule="oldSelf == '' || self == oldSelf",message="Region is immutable, cannot be changed on update"

cluster

object

cluster specifies the cluster name where the application will be deployed.

name string

Name of the cluster +kubebuilder:validation:Required +kubebuilder:validation:MinLength:=1 +kubebuilder:validation:MaxLength:=63 +kubebuilder:validation:XValidation:rule="oldSelf == '' || self == oldSelf",message="Cluster name is immutable once set"

type string

Possible values: [specified, auto]

Type of cluster selection +kubebuilder:validation:XValidation:rule="oldSelf == '' || self == oldSelf",message="Cluster selection type is immutable once set"

constraints

object

constraints specifies different constraint that the underlying infrastructe has to adhere to run the application. +optional

availability

object

tier string

Possible values: [basic, standard, premium]

+kubebuilder:default:=basic

networkTraffic

object

incomingRPS integer

IncomingRPS defines the inbound requests per second +kubebuilder:validation:Minimum:=0 +kubebuilder:default=10

outgoingRPS integer

OutgoingRPS defines the outbound requests per second If not configured, it will take the same value as IncomingRPS +kubebuilder:validation:Minimum:=0 +optional

resources

object

cpu

object

maximum

object

Format string

Possible values: [DecimalExponent, BinarySI, DecimalSI]

minimum

object

Format string

Possible values: [DecimalExponent, BinarySI, DecimalSI]

memory

object

maximum

object

Format string

Possible values: [DecimalExponent, BinarySI, DecimalSI]

minimum

object

Format string

Possible values: [DecimalExponent, BinarySI, DecimalSI]

id string

id is the unique identifier of the application profile.

name string

name is the name of the application profile.

orgId string

orgId is the organization ID.

slug string

slug is the unique identifier of the application profile.

]

id string
message string
status string

Example (from schema)

{
  "data": [
    {
      "clusterSelection": {
        "cloudProvider": {
          "availabilityZones": [
            "string"
          ],
          "provider": "aws",
          "region": "string"
        },
        "cluster": {
          "name": "string"
        },
        "type": "specified"
      },
      "constraints": {
        "availability": {
          "tier": "basic"
        },
        "networkTraffic": {
          "incomingRPS": 0,
          "outgoingRPS": 0
        },
        "resources": {
          "cpu": {
            "maximum": {
              "Format": "DecimalExponent"
            },
            "minimum": {
              "Format": "DecimalExponent"
            }
          },
          "memory": {
            "maximum": {
              "Format": "DecimalExponent"
            },
            "minimum": {
              "Format": "DecimalExponent"
            }
          }
        }
      },
      "id": "string",
      "name": "string",
      "orgId": "string",
      "slug": "string"
    }
  ],
  "id": "string",
  "message": "string",
  "status": "string"
}

400

bad request

application/json

Schema

Schema

error string
error_code string

Example (from schema)

{
  "error": "string",
  "error_code": "string"
}

404

application profile not found

application/json

Schema

Schema

error string
error_code string

Example (from schema)

{
  "error": "string",
  "error_code": "string"
}

500

internal server error

application/json

Schema

Schema

error string
error_code string

Example (from schema)

{
  "error": "string",
  "error_code": "string"
}

Loading...