REST
Common REST API components
Version: 0.1.0
Server
- URL:
https://api.kopernik.us/v0- Kopernik.us API server
Schemas
ProviderId
Provider identifier
Type: enum
Values:
akamaiawsdigitalocean
Metadata
Metadata of the request
Type: object
Properties:
| Name | Type | Required | Description |
|---|---|---|---|
| uid | string | ✅ | Unique identifier of the request |
| timestamp | number | ✅ | Timestamp of the request, in seconds since epoch |
Response
Response with metadata
Type: object
Properties:
| Name | Type | Required | Description |
|---|---|---|---|
| metadata | Metadata | ✅ |
EmptyResponse
Empty response
Composition: allOf
ErrorResponse
Error response
Composition: allOf
Type: object
Properties:
| Name | Type | Required | Description |
|---|---|---|---|
| reason | string | ✅ | Error details |
ResourceResponse
Response with resource
Composition: allOf
PagedResourceResponse
Response with paged resources
Composition: allOf
Type: object
Properties:
| Name | Type | Required | Description |
|---|---|---|---|
| nextToken | string | ❌ | Token for the next page, if there are more resources |
OAuthTokenResponse
Response with OAuth token
Composition: allOf
Type: object
Properties:
| Name | Type | Required | Description |
|---|---|---|---|
| accessToken | string | ❌ | OAuth access token |
| refreshToken | string | ❌ | OAuth refresh token |
| expiresIn | number | ❌ | OAuth access token expiration time, in seconds |