Subscriptions
Subscriptions
GetSubscription
Returns the subscription by id
Request
GET /api/manage/v1/Subscriptions/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | string | Identifier of subscription |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Succesfully returned |
|
| 400 | The reqeust is wrong |
|
| 403 | You don't have rights for the operation |
|
| 404 | Subscription is not found |
GetSubscriptions
Returns a list of all subscriptions of current user
Request
GET /api/manage/v1/Subscriptions[?skip&take]
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| skip | integer | 0 | Variable for pagination, defautl value is 0 |
| take | integer | 10 | Variable for pagination, default value is 10 |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Succesfully returned |
|
| 400 | unrealistic skip 'n take provided |
RenameSubscription
Rename subscription
Request
PUT /api/manage/v1/Subscriptions/{subscriptionId}/rename
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *subscriptionId | string | id |
|
| *renameSubscriptionVM | rename VM |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Successfully renamed |
|
| 400 | Request is wrong |
|
| 402 | Subscription is outdated |
|
| 403 | Not enough permissions |
|
| 404 | there is no subscription with such id (or user have no permission) |
UpdateLocale
Update subscription's default locale
Request
PUT /api/manage/v1/Subscriptions/{subscriptionId}/Locale
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *subscriptionId | string | id |
|
| *updateModel | update VM |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Successfully renamed |
|
| 400 | Request is wrong |
|
| 402 | Subscription is outdated |
|
| 403 | Not enough permissions |
|
| 404 | there is no subscription with such id (or user have no permission) |
GetDefaultPermissions
Get subscription's default permissions for new entities
Request
GET /api/manage/v1/Subscriptions/{subscriptionId}/defaultPermissions
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *subscriptionId | string | id |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Successfully returned |
|
| 400 | Request is wrong |
|
| 402 | subscription is outdated |
|
| 403 | Not enough permissions |
|
| 404 | there is no subscription with such id |
UpdateDefaultPermissions
Change subscription's default permissions for new entities
Request
PUT /api/manage/v1/Subscriptions/{subscriptionId}/defaultPermissions
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *subscriptionId | string | id |
|
| *permissionsVM | update default permissions VM |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Successfully changed |
|
| 400 | Request is wrong |
|
| 402 | subscription is outdated |
|
| 403 | Not enough permissions |
|
| 404 | there is no subscription with such id |
GetPermissions
Get permissions for a subscription by id
Request
GET /api/manage/v1/Subscriptions/{id}/permissions
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | string |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Succesfully returned |
|
| 403 | You don't have rights for the operation |
UpdatePermissions
Update permissions
Request
POST /api/manage/v1/Subscriptions/{id}/permissions
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | string | ||
| permissionsVM |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
|
| 400 | Bad Request |
|
| 402 | Client Error |
|
| 403 | Forbidden |
|
| 404 | Not Found |
|
| 500 | Server Error |