Categorygithub.com/stackitcloud/stackit-dns-api-client-go
modulepackage
0.0.0-20241206075225-be8f799f1c18
Repository: https://github.com/stackitcloud/stackit-dns-api-client-go.git
Documentation: pkg.go.dev

# README

Go API client for swagger

This api provides dns

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 1.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen

Installation

$ go get github.com/stackitcloud/stackit-dns-api-client-go@latest

Documentation for API Endpoints

All URIs are relative to https://api.dns.stackit.cloud

ClassMethodHTTP requestDescription
HealthApiHealthzGetGet /healthzHealth route
RecordSetApiV1ProjectsProjectIdZonesZoneIdRrsetsGetGet /v1/projects/{projectId}/zones/{zoneId}/rrsetsAll get selected RRSets
RecordSetApiV1ProjectsProjectIdZonesZoneIdRrsetsPostPost /v1/projects/{projectId}/zones/{zoneId}/rrsetsPost record set
RecordSetApiV1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdDeleteDelete /v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId}Delete a record set
RecordSetApiV1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdGetGet /v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId}Get a single rrset
RecordSetApiV1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdPatchPatch /v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId}Patch updates a record set
RecordSetApiV1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdRecordsPatchPatch /v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId}/recordsPatchRecords updates a record in a rrset
RecordSetApiV1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdRestoresPostPost /v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId}/restoresRestore record set
ZoneApiV1ProjectsProjectIdZonesGetGet /v1/projects/{projectId}/zonesAll get selected zones
ZoneApiV1ProjectsProjectIdZonesPostPost /v1/projects/{projectId}/zonesPost create a new zone
ZoneApiV1ProjectsProjectIdZonesZoneIdDeleteDelete /v1/projects/{projectId}/zones/{zoneId}Delete delete a zone
ZoneApiV1ProjectsProjectIdZonesZoneIdGetGet /v1/projects/{projectId}/zones/{zoneId}Get a single zone
ZoneApiV1ProjectsProjectIdZonesZoneIdPutPut /v1/projects/{projectId}/zones/{zoneId}Put update an existing zone
ZoneApiV1ProjectsProjectIdZonesZoneIdRestoresPostPost /v1/projects/{projectId}/zones/{zoneId}/restoresRestore an inactive zone but will not restore the record sets

Documentation For Models

Documentation For Authorization

bearerAuth

Author

[email protected]

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.

# Structs

APIClient manages communication with the STACKIT DNS API API v1.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
No description provided by the author
Record.
RRSet.
No description provided by the author
Zone.
GenericSwaggerError Provides access to the body, error and model on returned errors.
No description provided by the author
RecordPatch for record patch in record set.
RecordPost for rr set info.
ResponseRRSet for rr set info.
ResponseRRSetAll.
RRSetPatch for rr patch set info.
RRSetPost for rr set info.
No description provided by the author
No description provided by the author
ResponseZone for user info.
ResponseZoneAll for filtered zones.
Zone to create.

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author