\ResourceRecordsApi

All URIs are relative to https://gateway.stackpath.com

Method	HTTP request	Description
BulkCreateOrUpdateZoneRecords	Post /dns/v1/stacks/{stack_id}/zones/{zone_id}/bulk/records	Create or update multiple records
BulkDeleteZoneRecords	Post /dns/v1/stacks/{stack_id}/zones/{zone_id}/bulk/records/delete	Delete multiple records
CreateZoneRecord	Post /dns/v1/stacks/{stack_id}/zones/{zone_id}/records	Create a record
DeleteZoneRecord	Delete /dns/v1/stacks/{stack_id}/zones/{zone_id}/records/{zone_record_id}	Delete a record
GetZoneRecord	Get /dns/v1/stacks/{stack_id}/zones/{zone_id}/records/{zone_record_id}	Get a record
GetZoneRecords	Get /dns/v1/stacks/{stack_id}/zones/{zone_id}/records	Get all records
PatchZoneRecord	Patch /dns/v1/stacks/{stack_id}/zones/{zone_id}/records/{zone_record_id}	Replace a record
UpdateZoneRecord	Put /dns/v1/stacks/{stack_id}/zones/{zone_id}/records/{zone_record_id}	Update a record

BulkCreateOrUpdateZoneRecords

ZoneBulkCreateOrUpdateZoneRecordsResponse BulkCreateOrUpdateZoneRecords(ctx, stackId, zoneId).ZoneBulkCreateOrUpdateZoneRecordsRequest(zoneBulkCreateOrUpdateZoneRecordsRequest).Execute()

Create or update multiple records

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    stackId := "stackId_example" // string | A stack ID or slug
    zoneId := "zoneId_example" // string | A DNS zone ID
    zoneBulkCreateOrUpdateZoneRecordsRequest := openapiclient.zoneBulkCreateOrUpdateZoneRecordsRequest{Records: []ZoneBulkCreateOrUpdateZoneRecordMessage{openapiclient.zoneBulkCreateOrUpdateZoneRecordMessage{Name: "Name_example", Type: openapiclient.zoneRecordType{}, Ttl: 123, Data: "Data_example", Weight: 123, Labels: map[string]string{ "Key" = "Value" }, Id: "Id_example"})} // ZoneBulkCreateOrUpdateZoneRecordsRequest | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ResourceRecordsApi.BulkCreateOrUpdateZoneRecords(context.Background(), stackId, zoneId, zoneBulkCreateOrUpdateZoneRecordsRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ResourceRecordsApi.BulkCreateOrUpdateZoneRecords``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `BulkCreateOrUpdateZoneRecords`: ZoneBulkCreateOrUpdateZoneRecordsResponse
    fmt.Fprintf(os.Stdout, "Response from `ResourceRecordsApi.BulkCreateOrUpdateZoneRecords`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
stackId	string	A stack ID or slug
zoneId	string	A DNS zone ID

Other Parameters

Other parameters are passed through a pointer to a apiBulkCreateOrUpdateZoneRecordsRequest struct via the builder pattern

Name	Type	Description	Notes

zoneBulkCreateOrUpdateZoneRecordsRequest | ZoneBulkCreateOrUpdateZoneRecordsRequest | |

Return type

ZoneBulkCreateOrUpdateZoneRecordsResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

BulkDeleteZoneRecords

BulkDeleteZoneRecords(ctx, stackId, zoneId).ZoneBulkDeleteZoneRecordsMessage(zoneBulkDeleteZoneRecordsMessage).Execute()

Delete multiple records

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    stackId := "stackId_example" // string | A stack ID or slug
    zoneId := "zoneId_example" // string | A DNS zone ID
    zoneBulkDeleteZoneRecordsMessage := openapiclient.zoneBulkDeleteZoneRecordsMessage{ZoneRecordIds: []string{"ZoneRecordIds_example")} // ZoneBulkDeleteZoneRecordsMessage | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ResourceRecordsApi.BulkDeleteZoneRecords(context.Background(), stackId, zoneId, zoneBulkDeleteZoneRecordsMessage).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ResourceRecordsApi.BulkDeleteZoneRecords``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
stackId	string	A stack ID or slug
zoneId	string	A DNS zone ID

Other Parameters

Other parameters are passed through a pointer to a apiBulkDeleteZoneRecordsRequest struct via the builder pattern

Name	Type	Description	Notes

zoneBulkDeleteZoneRecordsMessage | ZoneBulkDeleteZoneRecordsMessage | |

Return type

(empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateZoneRecord

ZoneCreateZoneRecordResponse CreateZoneRecord(ctx, stackId, zoneId).ZoneUpdateZoneRecordMessage(zoneUpdateZoneRecordMessage).Execute()

Create a record

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    stackId := "stackId_example" // string | A stack ID or slug
    zoneId := "zoneId_example" // string | A DNS zone ID
    zoneUpdateZoneRecordMessage := openapiclient.zoneUpdateZoneRecordMessage{Name: "Name_example", Type: openapiclient.zoneRecordType{}, Ttl: 123, Data: "Data_example", Weight: 123, Labels: map[string]string{ "Key" = "Value" }} // ZoneUpdateZoneRecordMessage | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ResourceRecordsApi.CreateZoneRecord(context.Background(), stackId, zoneId, zoneUpdateZoneRecordMessage).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ResourceRecordsApi.CreateZoneRecord``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateZoneRecord`: ZoneCreateZoneRecordResponse
    fmt.Fprintf(os.Stdout, "Response from `ResourceRecordsApi.CreateZoneRecord`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
stackId	string	A stack ID or slug
zoneId	string	A DNS zone ID

Other Parameters

Other parameters are passed through a pointer to a apiCreateZoneRecordRequest struct via the builder pattern

Name	Type	Description	Notes

zoneUpdateZoneRecordMessage | ZoneUpdateZoneRecordMessage | |

Return type

ZoneCreateZoneRecordResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteZoneRecord

DeleteZoneRecord(ctx, stackId, zoneId, zoneRecordId).Execute()

Delete a record

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    stackId := "stackId_example" // string | A stack ID or slug
    zoneId := "zoneId_example" // string | A DNS zone ID
    zoneRecordId := "zoneRecordId_example" // string | A DNS resource record ID

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ResourceRecordsApi.DeleteZoneRecord(context.Background(), stackId, zoneId, zoneRecordId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ResourceRecordsApi.DeleteZoneRecord``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
stackId	string	A stack ID or slug
zoneId	string	A DNS zone ID
zoneRecordId	string	A DNS resource record ID

Other Parameters

Other parameters are passed through a pointer to a apiDeleteZoneRecordRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetZoneRecord

ZoneGetZoneRecordResponse GetZoneRecord(ctx, stackId, zoneId, zoneRecordId).Execute()

Get a record

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    stackId := "stackId_example" // string | A stack ID or slug
    zoneId := "zoneId_example" // string | A DNS zone ID
    zoneRecordId := "zoneRecordId_example" // string | A DNS resource record ID

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ResourceRecordsApi.GetZoneRecord(context.Background(), stackId, zoneId, zoneRecordId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ResourceRecordsApi.GetZoneRecord``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetZoneRecord`: ZoneGetZoneRecordResponse
    fmt.Fprintf(os.Stdout, "Response from `ResourceRecordsApi.GetZoneRecord`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
stackId	string	A stack ID or slug
zoneId	string	A DNS zone ID
zoneRecordId	string	A DNS resource record ID

Other Parameters

Other parameters are passed through a pointer to a apiGetZoneRecordRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ZoneGetZoneRecordResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetZoneRecords

ZoneGetZoneRecordsResponse GetZoneRecords(ctx, stackId, zoneId).PageRequestFirst(pageRequestFirst).PageRequestAfter(pageRequestAfter).PageRequestFilter(pageRequestFilter).PageRequestSortBy(pageRequestSortBy).Execute()

Get all records

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    stackId := "stackId_example" // string | A stack ID or slug
    zoneId := "zoneId_example" // string | A DNS zone ID
    pageRequestFirst := "pageRequestFirst_example" // string | The number of items desired. (optional)
    pageRequestAfter := "pageRequestAfter_example" // string | The cursor value after which data will be returned. (optional)
    pageRequestFilter := "pageRequestFilter_example" // string | SQL-style constraint filters. (optional)
    pageRequestSortBy := "pageRequestSortBy_example" // string | Sort the response by the given field. (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ResourceRecordsApi.GetZoneRecords(context.Background(), stackId, zoneId).PageRequestFirst(pageRequestFirst).PageRequestAfter(pageRequestAfter).PageRequestFilter(pageRequestFilter).PageRequestSortBy(pageRequestSortBy).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ResourceRecordsApi.GetZoneRecords``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetZoneRecords`: ZoneGetZoneRecordsResponse
    fmt.Fprintf(os.Stdout, "Response from `ResourceRecordsApi.GetZoneRecords`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
stackId	string	A stack ID or slug
zoneId	string	A DNS zone ID

Other Parameters

Other parameters are passed through a pointer to a apiGetZoneRecordsRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ZoneGetZoneRecordsResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchZoneRecord

ZoneUpdateZoneRecordResponse PatchZoneRecord(ctx, stackId, zoneId, zoneRecordId).ZonePatchZoneRecordMessage(zonePatchZoneRecordMessage).Execute()

Replace a record

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    stackId := "stackId_example" // string | A stack ID or slug
    zoneId := "zoneId_example" // string | A DNS zone ID
    zoneRecordId := "zoneRecordId_example" // string | A DNS resource record ID
    zonePatchZoneRecordMessage := openapiclient.zonePatchZoneRecordMessage{Name: "Name_example", Type: , Ttl: 123, Data: "Data_example", Weight: 123} // ZonePatchZoneRecordMessage | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ResourceRecordsApi.PatchZoneRecord(context.Background(), stackId, zoneId, zoneRecordId, zonePatchZoneRecordMessage).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ResourceRecordsApi.PatchZoneRecord``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PatchZoneRecord`: ZoneUpdateZoneRecordResponse
    fmt.Fprintf(os.Stdout, "Response from `ResourceRecordsApi.PatchZoneRecord`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
stackId	string	A stack ID or slug
zoneId	string	A DNS zone ID
zoneRecordId	string	A DNS resource record ID

Other Parameters

Other parameters are passed through a pointer to a apiPatchZoneRecordRequest struct via the builder pattern

Name	Type	Description	Notes

zonePatchZoneRecordMessage | ZonePatchZoneRecordMessage | |

Return type

ZoneUpdateZoneRecordResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateZoneRecord

ZoneUpdateZoneRecordResponse UpdateZoneRecord(ctx, stackId, zoneId, zoneRecordId).ZoneUpdateZoneRecordMessage(zoneUpdateZoneRecordMessage).Execute()

Update a record

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    stackId := "stackId_example" // string | A stack ID or slug
    zoneId := "zoneId_example" // string | A DNS zone ID
    zoneRecordId := "zoneRecordId_example" // string | A DNS resource record ID
    zoneUpdateZoneRecordMessage := openapiclient.zoneUpdateZoneRecordMessage{Name: "Name_example", Type: , Ttl: 123, Data: "Data_example", Weight: 123, Labels: map[string]string{ "Key" = "Value" }} // ZoneUpdateZoneRecordMessage | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ResourceRecordsApi.UpdateZoneRecord(context.Background(), stackId, zoneId, zoneRecordId, zoneUpdateZoneRecordMessage).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ResourceRecordsApi.UpdateZoneRecord``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateZoneRecord`: ZoneUpdateZoneRecordResponse
    fmt.Fprintf(os.Stdout, "Response from `ResourceRecordsApi.UpdateZoneRecord`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
stackId	string	A stack ID or slug
zoneId	string	A DNS zone ID
zoneRecordId	string	A DNS resource record ID

Other Parameters

Other parameters are passed through a pointer to a apiUpdateZoneRecordRequest struct via the builder pattern

Name	Type	Description	Notes

zoneUpdateZoneRecordMessage | ZoneUpdateZoneRecordMessage | |

Return type

ZoneUpdateZoneRecordResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ResourceRecordsApi.md

Latest commit

History

ResourceRecordsApi.md

File metadata and controls

\ResourceRecordsApi

BulkCreateOrUpdateZoneRecords

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

BulkDeleteZoneRecords

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateZoneRecord

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteZoneRecord

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetZoneRecord

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetZoneRecords

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PatchZoneRecord

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateZoneRecord

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers