TemplatesApi

All URIs are relative to https://api.ionos.com/cloudapi/v6
Method
HTTP request
Description
​TemplatesFindById​
Get /templates/{templateId}
Retrieve Cubes Templates
​TemplatesGet​
Get /templates
List Cubes Templates
TemplatesFindById
var result Template = TemplatesFindById(ctx, templateId)
                      .Depth(depth)
                      .Execute()
Retrieve Cubes Templates
Example
package main
​
import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)
​
func main() {
    templateId := "templateId_example" // string | The unique Template ID.
    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)
​
    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TemplatesApi.TemplatesFindById(context.Background(), templateId).Depth(depth).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TemplatesApi.TemplatesFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `TemplatesFindById`: Template
    fmt.Fprintf(os.Stdout, "Response from `TemplatesApi.TemplatesFindById`: %v\n", resp)
}
Path Parameters
Name
Type
Description
Notes
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
​
templateId
string
The unique Template ID.
​
Other Parameters
Other parameters are passed through a pointer to a apiTemplatesFindByIdRequest struct via the builder pattern
Name
Type
Description
Notes
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]
Return type
​Template​
HTTP request headers
Content-Type: Not defined
Accept: application/json
TemplatesGet
var result Templates = TemplatesGet(ctx)
                      .Depth(depth)
                      .Execute()
List Cubes Templates
Example
package main
​
import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)
​
func main() {
    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)
​
    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TemplatesApi.TemplatesGet(context.Background()).Depth(depth).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TemplatesApi.TemplatesGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `TemplatesGet`: Templates
    fmt.Fprintf(os.Stdout, "Response from `TemplatesApi.TemplatesGet`: %v\n", resp)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiTemplatesGetRequest struct via the builder pattern
Name
Type
Description
Notes
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]
Return type
​Templates​
HTTP request headers
Content-Type: Not defined
Accept: application/json

Method	HTTP request	Description
TemplatesFindById	Get /templates/{templateId}	Retrieve Cubes Templates
TemplatesGet	Get /templates	List Cubes Templates

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId	string	The unique Template ID.

Name	Type	Description	Notes
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]

Name	Type	Description	Notes
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]

Last modified 11mo ago