All URIs are relative to https://api.ionos.com/cloudapi/v6
Delete groups
Other parameters are passed through a pointer to a apiUmGroupsDeleteRequest struct via the builder pattern
(empty response body)
Content-Type: Not defined
Accept: application/json
Retrieve groups
Other parameters are passed through a pointer to a apiUmGroupsFindByIdRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
List all groups
Other parameters are passed through a pointer to a apiUmGroupsGetRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Create groups
Other parameters are passed through a pointer to a apiUmGroupsPostRequest struct via the builder pattern
Content-Type: application/json
Accept: application/json
Modify groups
Other parameters are passed through a pointer to a apiUmGroupsPutRequest struct via the builder pattern
Content-Type: application/json
Accept: application/json
Retrieve group resources
Other parameters are passed through a pointer to a apiUmGroupsResourcesGetRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Remove group shares
Other parameters are passed through a pointer to a apiUmGroupsSharesDeleteRequest struct via the builder pattern
(empty response body)
Content-Type: Not defined
Accept: application/json
Retrieve group shares
Other parameters are passed through a pointer to a apiUmGroupsSharesFindByResourceIdRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
List group shares
Other parameters are passed through a pointer to a apiUmGroupsSharesGetRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Add group shares
Other parameters are passed through a pointer to a apiUmGroupsSharesPostRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Modify group share privileges
Other parameters are passed through a pointer to a apiUmGroupsSharesPutRequest struct via the builder pattern
Content-Type: application/json
Accept: application/json
Remove users from groups
Other parameters are passed through a pointer to a apiUmGroupsUsersDeleteRequest struct via the builder pattern
(empty response body)
Content-Type: Not defined
Accept: application/json
List group members
Other parameters are passed through a pointer to a apiUmGroupsUsersGetRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Add a Group Member
Other parameters are passed through a pointer to a apiUmGroupsUsersPostRequest struct via the builder pattern
Content-Type: application/json
Accept: application/json
List resources by type
Other parameters are passed through a pointer to a apiUmResourcesFindByTypeRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Retrieve resources by type
Other parameters are passed through a pointer to a apiUmResourcesFindByTypeAndIdRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
List all resources
Other parameters are passed through a pointer to a apiUmResourcesGetRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Delete users
Other parameters are passed through a pointer to a apiUmUsersDeleteRequest struct via the builder pattern
(empty response body)
Content-Type: Not defined
Accept: application/json
Retrieve users
Other parameters are passed through a pointer to a apiUmUsersFindByIdRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
List all users
Other parameters are passed through a pointer to a apiUmUsersGetRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Retrieve group resources by user ID
Other parameters are passed through a pointer to a apiUmUsersGroupsGetRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Retrieve user resources by user ID
Other parameters are passed through a pointer to a apiUmUsersOwnsGetRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Create users
Other parameters are passed through a pointer to a apiUmUsersPostRequest struct via the builder pattern
Content-Type: application/json
Accept: application/json
Modify users
Other parameters are passed through a pointer to a apiUmUsersPutRequest struct via the builder pattern
Content-Type: application/json
Accept: application/json
Method | HTTP request | Description |
---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Delete /um/groups/{groupId}
Delete groups
Get /um/groups/{groupId}
Retrieve groups
Get /um/groups
List all groups
Post /um/groups
Create groups
Put /um/groups/{groupId}
Modify groups
Get /um/groups/{groupId}/resources
Retrieve group resources
Delete /um/groups/{groupId}/shares/{resourceId}
Remove group shares
Get /um/groups/{groupId}/shares/{resourceId}
Retrieve group shares
Get /um/groups/{groupId}/shares
List group shares
Post /um/groups/{groupId}/shares/{resourceId}
Add group shares
Put /um/groups/{groupId}/shares/{resourceId}
Modify group share privileges
Delete /um/groups/{groupId}/users/{userId}
Remove users from groups
Get /um/groups/{groupId}/users
List group members
Post /um/groups/{groupId}/users
Add a Group Member
Get /um/resources/{resourceType}
List resources by type
Get /um/resources/{resourceType}/{resourceId}
Retrieve resources by type
Get /um/resources
List all resources
Delete /um/users/{userId}
Delete users
Get /um/users/{userId}
Retrieve users
Get /um/users
List all users
Get /um/users/{userId}/groups
Retrieve group resources by user ID
Get /um/users/{userId}/owns
Retrieve user resources by user ID
Post /um/users
Create users
Put /um/users/{userId}
Modify users
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
The unique ID of the group.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
The unique ID of the group.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
group
The group to create.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
The unique ID of the group.
group
The modified group.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
The unique ID of the group.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
The unique ID of the group.
resourceId
string
The unique ID of the resource.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
The unique ID of the group.
resourceId
string
The unique ID of the resource.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
The unique ID of the group.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
The unique ID of the group.
resourceId
string
The unique ID of the resource.
resource
The resource to add.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
The unique ID of the group.
resourceId
string
The unique ID of the resource.
resource
The modified resource
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
The unique ID of the group.
userId
string
The unique ID of the user.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
The unique ID of the group.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
The unique ID of the group.
user
The user to add.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
resourceType
string
The resource type
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
resourceType
string
The resource type
resourceId
string
The resource ID
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
userId
string
The unique ID of the user.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
userId
string
The unique ID of the user.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
offset
int32
The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination).
[default to 0]
limit
int32
The maximum number of elements to return (use together with <code>offset</code> for pagination).
[default to 100]
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
userId
string
The unique ID of the user.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
userId
string
The unique ID of the user.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
user
The user to create.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
userId
string
The unique ID of the user.
user
The modified user
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.