All URIs are relative to https://api.ionos.com/cloudapi/v5
Method
HTTP request
Description
Delete /snapshots/{snapshotId}
Delete a Snapshot
Get /snapshots/{snapshotId}
Retrieve a Snapshot by its uuid.
Get /snapshots
List Snapshots
Patch /snapshots/{snapshotId}
Partially modify a Snapshot
Put /snapshots/{snapshotId}
Modify a Snapshot
SnapshotsDelete
var result map[string]interface{} =SnapshotsDelete(ctx, snapshotId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Delete a Snapshot
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { snapshotId :="snapshotId_example"// string | The unique ID of the Snapshot pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) depth := int32(56) // int32 | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.SnapshotApi.SnapshotsDelete(context.Background(), snapshotId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `SnapshotApi.SnapshotsDelete``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `SnapshotsDelete`: map[string]interface{} fmt.Fprintf(os.Stdout, "Response from `SnapshotApi.SnapshotsDelete`: %v\n", resp)}
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 response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
Return type
map[string]interface{}
HTTP request headers
Content-Type: Not defined
Accept: application/json
SnapshotsFindById
var result Snapshot=SnapshotsFindById(ctx, snapshotId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Retrieve a Snapshot by its uuid.
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { snapshotId :="snapshotId_example"// string | The unique ID of the Snapshot pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) depth := int32(56) // int32 | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.SnapshotApi.SnapshotsFindById(context.Background(), snapshotId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `SnapshotApi.SnapshotsFindById``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `SnapshotsFindById`: Snapshot fmt.Fprintf(os.Stdout, "Response from `SnapshotApi.SnapshotsFindById`: %v\n", resp)}
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 response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
var result Snapshots=SnapshotsGet(ctx) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
List Snapshots
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) depth := int32(56) // int32 | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.SnapshotApi.SnapshotsGet(context.Background()).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `SnapshotApi.SnapshotsGet``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `SnapshotsGet`: Snapshots fmt.Fprintf(os.Stdout, "Response from `SnapshotApi.SnapshotsGet`: %v\n", resp)}
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 response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
var result Snapshot=SnapshotsPatch(ctx, snapshotId) .Snapshot(snapshot) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Partially modify a Snapshot
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { snapshotId :="snapshotId_example"// string | The unique ID of the Snapshot snapshot :=*openapiclient.NewSnapshotProperties() // SnapshotProperties | Modified Snapshot pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) depth := int32(56) // int32 | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.SnapshotApi.SnapshotsPatch(context.Background(), snapshotId).Snapshot(snapshot).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `SnapshotApi.SnapshotsPatch``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `SnapshotsPatch`: Snapshot fmt.Fprintf(os.Stdout, "Response from `SnapshotApi.SnapshotsPatch`: %v\n", resp)}
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
Modified Snapshot
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
var result Snapshot=SnapshotsPut(ctx, snapshotId) .Snapshot(snapshot) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Modify a Snapshot
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { snapshotId :="snapshotId_example"// string | The unique ID of the Snapshot snapshot :=*openapiclient.NewSnapshot(*openapiclient.NewSnapshotProperties()) // Snapshot | Modified Snapshot pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) depth := int32(56) // int32 | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.SnapshotApi.SnapshotsPut(context.Background(), snapshotId).Snapshot(snapshot).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `SnapshotApi.SnapshotsPut``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `SnapshotsPut`: Snapshot fmt.Fprintf(os.Stdout, "Response from `SnapshotApi.SnapshotsPut`: %v\n", resp)}
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
Modified Snapshot
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed