Static Data
API for static data operations
Version: 0.1.0
Server
- URL:
https://api.kopernik.us/v0- Kopernik.us API server
Paths
/staticdata
GET
Get static data
Get static data of the API server
Responses:
-
200: Static data of the API server
- Content Type:
application/json- Schema: StaticDataResponse
- Content Type:
-
404: API data not available
- Content Type:
application/json- Schema: ErrorResponse
- Content Type:
/staticdata/{providerUid}
GET
Get provider static data
Get provider descriptive static data
Parameters:
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| providerUid | path | ProviderId | ✅ | Unique identifier of the provider |
Responses:
-
200: Provider static data
- Content Type:
application/json- Schema: ProviderStaticDataResponse
- Content Type:
-
404: Provider not found
- Content Type:
application/json- Schema: ErrorResponse
- Content Type:
Schemas
StaticData
Static data of the API server
Type: object
Properties:
| Name | Type | Required | Description |
|---|---|---|---|
| maxAccounts | number | ✅ | Maximum number of accounts for Web application use |
StaticDataResponse
Response with API server static data
Composition: allOf
Type: object
Properties:
| Name | Type | Required | Description |
|---|---|---|---|
| staticData | StaticData | ✅ |
ProviderStaticData
Provider descriptive static data
Type: object
Properties:
| Name | Type | Required | Description |
|---|---|---|---|
| uid | ProviderId | ✅ | |
| name | string | ✅ | Name of the provider, as displayed to the user |
| regionalAuth | boolean | ✅ | Whether the provider authentication requires region selection (true) or is global (false) |
| oauthLoginRef | string | ❌ | Reference to the OAuth login page of the provider |
| oauthClientId | string | ❌ | Client ID of the OAuth client of the provider |
| limits | object | ✅ | Limits of the provider |
Properties of limits:
| Name | Type | Required | Description |
|---|---|---|---|
| service | object | ✅ | Limits of the provider by service |
Properties of limits.service:
| Name | Type | Required | Description |
|---|---|---|---|
| blockstorage | object | ✅ | Limits of the Block Storage support by the provider |
| firewall | object | ✅ | Limits of the Firewall support by the provider |
| kubernetes | object | ✅ | Limits of the Kubernetes support by the provider |
| machine | object | ✅ | Limits of the Machine support by the provider |
| vpc | object | ✅ | Limits of the VPC support by the provider |
Properties of limits.service.blockstorage:
| Name | Type | Required | Description |
|---|---|---|---|
| volumeSize | object | ✅ | Limits of the Block Storage volume size |
Properties of limits.service.blockstorage.volumeSize:
| Name | Type | Required | Description |
|---|---|---|---|
| min | number | ✅ | Minimum volume size in GB |
| max | number | ✅ | Maximum volume size in GB |
Properties of limits.service.firewall:
| Name | Type | Required | Description |
|---|---|---|---|
| minRules | number | ✅ | Minimum number of rules for the firewall |
| regionBound | boolean | ✅ | Whether the firewall must be bound to a region |
| supportedPeerTypes | array<PeerType> | ✅ | Supported peer types for the firewall |
| supportedProtocols | array<Protocol> | ✅ | Supported protocols for the firewall |
| vpcBound | boolean | ✅ | Whether the firewall must be bound to a VPC |
Properties of limits.service.kubernetes:
| Name | Type | Required | Description |
|---|---|---|---|
| cluster | object | ✅ | Limits of the Kubernetes cluster support by the provider |
| nodePool | object | ✅ | Limits of the Kubernetes node pool support by the provider |
Properties of limits.service.kubernetes.cluster:
| Name | Type | Required | Description |
|---|---|---|---|
| maxNodePools | number | ✅ | Maximum number of node pools for the Kubernetes cluster |
| requiresRole | boolean | ✅ | Whether the Kubernetes cluster requires a role |
| supportedVersions | array |
✅ | Supported versions of the Kubernetes cluster |
| vpc | object | ❌ | Limits of the Kubernetes VPC support by the provider; if not set, VPC is not supported |
Properties of limits.service.kubernetes.cluster.vpc:
| Name | Type | Required | Description |
|---|---|---|---|
| required | boolean | ✅ | Whether the Kubernetes cluster requires a VPC |
| minSubnets | number | ✅ | Minimum number of Subnets that must be created in a VPC |
Properties of limits.service.kubernetes.nodePool:
| Name | Type | Required | Description |
|---|---|---|---|
| maxNodeCount | number | ✅ | Maximum number of nodes for the Kubernetes node pool |
| requiresRole | boolean | ✅ | Whether the Kubernetes node pool requires a role |
| minRamGb | number | ❌ | Minimum RAM in GB for the Kubernetes node pool workers |
Properties of limits.service.machine:
| Name | Type | Required | Description |
|---|---|---|---|
| requiresVpc | boolean | ✅ | Whether Machines must be created in a VPC |
| maxVolumes | number | ✅ | Maximum number of volumes that can be attached to a Machine |
| minRootDiskGb | number | ✅ | Minimum allowed root disk size in GB |
Properties of limits.service.vpc:
| Name | Type | Required | Description |
|---|---|---|---|
| subnet | object | ✅ | Limits of the VPC Subnet support by the provider |
Properties of limits.service.vpc.subnet:
| Name | Type | Required | Description |
|---|---|---|---|
| maxSubnets | number | ✅ | Maximum number of Subnets that can be created in a VPC |
ProviderStaticDataResponse
Response with provider static data
Composition: allOf
Type: object
Properties:
| Name | Type | Required | Description |
|---|---|---|---|
| staticData | ProviderStaticData | ✅ |