Skip to content

Latest commit

 

History

History
224 lines (153 loc) · 9.27 KB

ZoneApi.md

File metadata and controls

224 lines (153 loc) · 9.27 KB

{{classname}}

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

Method HTTP request Description
V1ProjectsProjectIdZonesGet Get /v1/projects/{projectId}/zones All get selected zones
V1ProjectsProjectIdZonesPost Post /v1/projects/{projectId}/zones Post create a new zone
V1ProjectsProjectIdZonesZoneIdDelete Delete /v1/projects/{projectId}/zones/{zoneId} Delete delete a zone
V1ProjectsProjectIdZonesZoneIdGet Get /v1/projects/{projectId}/zones/{zoneId} Get a single zone
V1ProjectsProjectIdZonesZoneIdPut Put /v1/projects/{projectId}/zones/{zoneId} Put update an existing zone
V1ProjectsProjectIdZonesZoneIdRestoresPost Post /v1/projects/{projectId}/zones/{zoneId}/restores Restore an inactive zone but will not restore the record sets

V1ProjectsProjectIdZonesGet

ZoneResponseZoneAll V1ProjectsProjectIdZonesGet(ctx, projectId, optional) All get selected zones

All zone

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId string project id
optional *ZoneApiV1ProjectsProjectIdZonesGetOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ZoneApiV1ProjectsProjectIdZonesGetOpts struct

Name Type Description Notes

page | optional.Int32| page | [default to 1] pageSize | optional.Int32| page size | [default to 100] dnsNameEq | optional.String| filter dns name equal | dnsNameLike | optional.String| filter dns name like | typeEq | optional.String| filter type | primaryNameServerEq | optional.String| filter primary name server equal | primaryNameServerLike | optional.String| filter primary name server like | isReverseZoneEq | optional.Bool| filter reverse zone equal | activeEq | optional.Bool| filter active equal | creationStartedGt | optional.String| filter creation started greater with utc timestamp | creationStartedLt | optional.String| filter creation started lesser with utc timestamp | creationStartedGte | optional.String| filter creation started greater equal with utc timestamp | creationStartedLte | optional.String| filter creation started lesser equal with utc timestamp | creationFinishedGt | optional.String| filter creation finished greater with utc timestamp | creationFinishedLt | optional.String| filter creation finished lesser with utc timestamp | creationFinishedGte | optional.String| filter creation finished greater equal with utc timestamp | creationFinishedLte | optional.String| filter creation finished lesser equal with utc timestamp | updateStartedGt | optional.String| filter update started greater with utc timestamp | updateStartedLt | optional.String| filter update started lesser with utc timestamp | updateStartedGte | optional.String| filter update started greater equal with utc timestamp | updateStartedLte | optional.String| filter update started lesser equal with utc timestamp | updateFinishedGt | optional.String| filter update finished greater with utc timestamp | updateFinishedLt | optional.String| filter update finished lesser with utc timestamp | updateFinishedGte | optional.String| filter update finished greater equal with utc timestamp | updateFinishedLte | optional.String| filter update finished lesser equal with utc timestamp | orderByDnsName | optional.String| order by dns name | orderByCreationStarted | optional.String| order by creationStarted | orderByCreationFinished | optional.String| order by creationFinished | orderByUpdateStarted | optional.String| order by updateStarted | orderByUpdateFinished | optional.String| order by updateFinished |

Return type

ZoneResponseZoneAll

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

V1ProjectsProjectIdZonesPost

ZoneResponseZone V1ProjectsProjectIdZonesPost(ctx, body, projectId) Post create a new zone

Post zone create a new zone

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body ZoneZonePost zone to create
projectId string project id

Return type

ZoneResponseZone

Authorization

bearerAuth

HTTP request headers

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

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

V1ProjectsProjectIdZonesZoneIdDelete

SerializerMessage V1ProjectsProjectIdZonesZoneIdDelete(ctx, projectId, zoneId) Delete delete a zone

Delete delete a zone

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId string project id
zoneId string zone id

Return type

SerializerMessage

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

V1ProjectsProjectIdZonesZoneIdGet

ZoneResponseZone V1ProjectsProjectIdZonesZoneIdGet(ctx, projectId, zoneId) Get a single zone

Get zone

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId string project id
zoneId string zone id

Return type

ZoneResponseZone

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

V1ProjectsProjectIdZonesZoneIdPut

ZoneResponseZone V1ProjectsProjectIdZonesZoneIdPut(ctx, body, projectId, zoneId) Put update an existing zone

Put update an existing zone

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body DomainUpdateZone zone to update
projectId string project id
zoneId string zone id

Return type

ZoneResponseZone

Authorization

bearerAuth

HTTP request headers

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

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

V1ProjectsProjectIdZonesZoneIdRestoresPost

SerializerMessage V1ProjectsProjectIdZonesZoneIdRestoresPost(ctx, projectId, zoneId) Restore an inactive zone but will not restore the record sets

Restore an inactive zone but will not restore the record sets

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId string project id
zoneId string zone id

Return type

SerializerMessage

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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