SnapshotsApi

All URIs are relative to https://api.ionos.com/cloudapi/v6
Method
HTTP request
Description
​SnapshotsDelete​
Delete /snapshots/{snapshotId}
Delete snapshots
​SnapshotsFindById​
Get /snapshots/{snapshotId}
Retrieve snapshots by ID
​SnapshotsGet​
Get /snapshots
List snapshots
​SnapshotsPatch​
Patch /snapshots/{snapshotId}
Partially modify snapshots
​SnapshotsPut​
Put /snapshots/{snapshotId}
Modify snapshots
SnapshotsDelete
1
var result  = SnapshotsDelete(ctx, snapshotId)
2
                      .Pretty(pretty)
3
                      .Depth(depth)
4
                      .XContractNumber(xContractNumber)
5
                      .Execute()
Copied!
Delete snapshots
Example
1
package main
2
​
3
import (
4
    "context"
5
    "fmt"
6
    "os"
7
    openapiclient "./openapi"
8
)
9
​
10
func main() {
11
    snapshotId := "snapshotId_example" // string | The unique ID of the snapshot.
12
    pretty := true // bool | Controls whether the response is pretty-printed (with indentations and new lines). (optional) (default to true)
13
    depth := int32(56) // 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 (optional) (default to 0)
14
    xContractNumber := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. (optional)
15
​
16
    configuration := openapiclient.NewConfiguration()
17
    apiClient := openapiclient.NewAPIClient(configuration)
18
    resp, r, err := apiClient.SnapshotsApi.SnapshotsDelete(context.Background(), snapshotId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
19
    if err != nil {
20
        fmt.Fprintf(os.Stderr, "Error when calling `SnapshotsApi.SnapshotsDelete``: %v\n", err)
21
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
22
    }
23
}
Copied!
Path Parameters
Name
Type
Description
Notes
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
​
snapshotId
string
The unique ID of the snapshot.
​
Other Parameters
Other parameters are passed through a pointer to a apiSnapshotsDeleteRequest struct via the builder pattern
Name
Type
Description
Notes
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.
​
Return type
(empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
SnapshotsFindById
1
var result Snapshot = SnapshotsFindById(ctx, snapshotId)
2
                      .Pretty(pretty)
3
                      .Depth(depth)
4
                      .XContractNumber(xContractNumber)
5
                      .Execute()
Copied!
Retrieve snapshots by ID
Example
1
package main
2
​
3
import (
4
    "context"
5
    "fmt"
6
    "os"
7
    openapiclient "./openapi"
8
)
9
​
10
func main() {
11
    snapshotId := "snapshotId_example" // string | The unique ID of the snapshot.
12
    pretty := true // bool | Controls whether the response is pretty-printed (with indentations and new lines). (optional) (default to true)
13
    depth := int32(56) // 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 (optional) (default to 0)
14
    xContractNumber := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. (optional)
15
​
16
    configuration := openapiclient.NewConfiguration()
17
    apiClient := openapiclient.NewAPIClient(configuration)
18
    resp, r, err := apiClient.SnapshotsApi.SnapshotsFindById(context.Background(), snapshotId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
19
    if err != nil {
20
        fmt.Fprintf(os.Stderr, "Error when calling `SnapshotsApi.SnapshotsFindById``: %v\n", err)
21
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
22
    }
23
    // response from `SnapshotsFindById`: Snapshot
24
    fmt.Fprintf(os.Stdout, "Response from `SnapshotsApi.SnapshotsFindById`: %v\n", resp)
25
}
Copied!
Path Parameters
Name
Type
Description
Notes
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
​
snapshotId
string
The unique ID of the snapshot.
​
Other Parameters
Other parameters are passed through a pointer to a apiSnapshotsFindByIdRequest struct via the builder pattern
Name
Type
Description
Notes
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.
​
Return type
​Snapshot​
HTTP request headers
Content-Type: Not defined
Accept: application/json
SnapshotsGet
1
var result Snapshots = SnapshotsGet(ctx)
2
                      .Pretty(pretty)
3
                      .Depth(depth)
4
                      .XContractNumber(xContractNumber)
5
                      .Execute()
Copied!
List snapshots
Example
1
package main
2
​
3
import (
4
    "context"
5
    "fmt"
6
    "os"
7
    openapiclient "./openapi"
8
)
9
​
10
func main() {
11
    pretty := true // bool | Controls whether the response is pretty-printed (with indentations and new lines). (optional) (default to true)
12
    depth := int32(56) // 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 (optional) (default to 0)
13
    xContractNumber := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. (optional)
14
​
15
    configuration := openapiclient.NewConfiguration()
16
    apiClient := openapiclient.NewAPIClient(configuration)
17
    resp, r, err := apiClient.SnapshotsApi.SnapshotsGet(context.Background()).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
18
    if err != nil {
19
        fmt.Fprintf(os.Stderr, "Error when calling `SnapshotsApi.SnapshotsGet``: %v\n", err)
20
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
21
    }
22
    // response from `SnapshotsGet`: Snapshots
23
    fmt.Fprintf(os.Stdout, "Response from `SnapshotsApi.SnapshotsGet`: %v\n", resp)
24
}
Copied!
Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiSnapshotsGetRequest struct via the builder pattern
Name
Type
Description
Notes
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.
​
Return type
​Snapshots​
HTTP request headers
Content-Type: Not defined
Accept: application/json
SnapshotsPatch
1
var result Snapshot = SnapshotsPatch(ctx, snapshotId)
2
                      .Snapshot(snapshot)
3
                      .Pretty(pretty)
4
                      .Depth(depth)
5
                      .XContractNumber(xContractNumber)
6
                      .Execute()
Copied!
Partially modify snapshots
Example
1
package main
2
​
3
import (
4
    "context"
5
    "fmt"
6
    "os"
7
    openapiclient "./openapi"
8
)
9
​
10
func main() {
11
    snapshotId := "snapshotId_example" // string | The unique ID of the snapshot.
12
    snapshot := *openapiclient.NewSnapshotProperties() // SnapshotProperties | The properties of the snapshot to be updated.
13
    pretty := true // bool | Controls whether the response is pretty-printed (with indentations and new lines). (optional) (default to true)
14
    depth := int32(56) // 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 (optional) (default to 0)
15
    xContractNumber := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. (optional)
16
​
17
    configuration := openapiclient.NewConfiguration()
18
    apiClient := openapiclient.NewAPIClient(configuration)
19
    resp, r, err := apiClient.SnapshotsApi.SnapshotsPatch(context.Background(), snapshotId).Snapshot(snapshot).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
20
    if err != nil {
21
        fmt.Fprintf(os.Stderr, "Error when calling `SnapshotsApi.SnapshotsPatch``: %v\n", err)
22
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
23
    }
24
    // response from `SnapshotsPatch`: Snapshot
25
    fmt.Fprintf(os.Stdout, "Response from `SnapshotsApi.SnapshotsPatch`: %v\n", resp)
26
}
Copied!
Path Parameters
Name
Type
Description
Notes
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
​
snapshotId
string
The unique ID of the snapshot.
​
Other Parameters
Other parameters are passed through a pointer to a apiSnapshotsPatchRequest struct via the builder pattern
Name
Type
Description
Notes
snapshot
​SnapshotProperties​
The properties of the snapshot to be updated.
​
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.
​
Return type
​Snapshot​
HTTP request headers
Content-Type: application/json
Accept: application/json
SnapshotsPut
1
var result Snapshot = SnapshotsPut(ctx, snapshotId)
2
                      .Snapshot(snapshot)
3
                      .Pretty(pretty)
4
                      .Depth(depth)
5
                      .XContractNumber(xContractNumber)
6
                      .Execute()
Copied!
Modify snapshots
Example
1
package main
2
​
3
import (
4
    "context"
5
    "fmt"
6
    "os"
7
    openapiclient "./openapi"
8
)
9
​
10
func main() {
11
    snapshotId := "snapshotId_example" // string | The unique ID of the snapshot.
12
    snapshot := *openapiclient.NewSnapshot(*openapiclient.NewSnapshotProperties()) // Snapshot | The modified snapshot
13
    pretty := true // bool | Controls whether the response is pretty-printed (with indentations and new lines). (optional) (default to true)
14
    depth := int32(56) // 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 (optional) (default to 0)
15
    xContractNumber := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. (optional)
16
​
17
    configuration := openapiclient.NewConfiguration()
18
    apiClient := openapiclient.NewAPIClient(configuration)
19
    resp, r, err := apiClient.SnapshotsApi.SnapshotsPut(context.Background(), snapshotId).Snapshot(snapshot).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
20
    if err != nil {
21
        fmt.Fprintf(os.Stderr, "Error when calling `SnapshotsApi.SnapshotsPut``: %v\n", err)
22
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
23
    }
24
    // response from `SnapshotsPut`: Snapshot
25
    fmt.Fprintf(os.Stdout, "Response from `SnapshotsApi.SnapshotsPut`: %v\n", resp)
26
}
Copied!
Path Parameters
Name
Type
Description
Notes
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
​
snapshotId
string
The unique ID of the snapshot.
​
Other Parameters
Other parameters are passed through a pointer to a apiSnapshotsPutRequest struct via the builder pattern
Name
Type
Description
Notes
snapshot
​Snapshot​
The modified snapshot
​
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.
​
Return type
​Snapshot​
HTTP request headers
Content-Type: application/json
Accept: application/json

API - Previous

ServersApi

Next - API

TemplatesApi

Last modified 3mo ago