# 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
Class | Method | HTTP request | Description |
---|---|---|---|
HealthApi | HealthzGet | Get /healthz | Health route |
RecordSetApi | V1ProjectsProjectIdZonesZoneIdRrsetsGet | Get /v1/projects/{projectId}/zones/{zoneId}/rrsets | All get selected RRSets |
RecordSetApi | V1ProjectsProjectIdZonesZoneIdRrsetsPost | Post /v1/projects/{projectId}/zones/{zoneId}/rrsets | Post record set |
RecordSetApi | V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdDelete | Delete /v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId} | Delete a record set |
RecordSetApi | V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdGet | Get /v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId} | Get a single rrset |
RecordSetApi | V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdPatch | Patch /v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId} | Patch updates a record set |
RecordSetApi | V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdRecordsPatch | Patch /v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId}/records | PatchRecords updates a record in a rrset |
RecordSetApi | V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdRestoresPost | Post /v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId}/restores | Restore record set |
ZoneApi | V1ProjectsProjectIdZonesGet | Get /v1/projects/{projectId}/zones | All get selected zones |
ZoneApi | V1ProjectsProjectIdZonesPost | Post /v1/projects/{projectId}/zones | Post create a new zone |
ZoneApi | V1ProjectsProjectIdZonesZoneIdDelete | Delete /v1/projects/{projectId}/zones/{zoneId} | Delete delete a zone |
ZoneApi | V1ProjectsProjectIdZonesZoneIdGet | Get /v1/projects/{projectId}/zones/{zoneId} | Get a single zone |
ZoneApi | V1ProjectsProjectIdZonesZoneIdPut | Put /v1/projects/{projectId}/zones/{zoneId} | Put update an existing zone |
ZoneApi | V1ProjectsProjectIdZonesZoneIdRestoresPost | Post /v1/projects/{projectId}/zones/{zoneId}/restores | Restore an inactive zone but will not restore the record sets |
Documentation For Models
- DomainRecord
- DomainRrSet
- DomainUpdateZone
- DomainZone
- RrsetRecordPatch
- RrsetRecordPost
- RrsetResponseRrSet
- RrsetResponseRrSetAll
- RrsetRrSetPatch
- RrsetRrSetPost
- SerializerMessage
- ZoneResponseZone
- ZoneResponseZoneAll
- ZoneZonePost
Documentation For Authorization
bearerAuth
Author
# 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