RecordSetApi.md

{{classname}}

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

Method	HTTP request	Description
V1ProjectsProjectIdZonesZoneIdRrsetsGet	Get /v1/projects/{projectId}/zones/{zoneId}/rrsets	All get selected RRSets
V1ProjectsProjectIdZonesZoneIdRrsetsPost	Post /v1/projects/{projectId}/zones/{zoneId}/rrsets	Post record set
V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdDelete	Delete /v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId}	Delete a record set
V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdGet	Get /v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId}	Get a single rrset
V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdPatch	Patch /v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId}	Patch updates a record set
V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdRecordsPatch	Patch /v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId}/records	PatchRecords updates a record in a rrset
V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdRestoresPost	Post /v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId}/restores	Restore record set

V1ProjectsProjectIdZonesZoneIdRrsetsGet

RrsetResponseRrSetAll V1ProjectsProjectIdZonesZoneIdRrsetsGet(ctx, projectId, zoneId, optional) All get selected RRSets

All RRSet

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
optional	*RecordSetApiV1ProjectsProjectIdZonesZoneIdRrsetsGetOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RecordSetApiV1ProjectsProjectIdZonesZoneIdRrsetsGetOpts struct

Name	Type	Description	Notes

page | optional.Int32| page | [default to 1] pageSize | optional.Int32| page size | [default to 100] nameEq | optional.String| filter name equal | nameLike | optional.String| filter name like | typeEq | optional.String| filter type | 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 | orderByName | optional.String| order by 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

RrsetResponseRrSetAll

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]

V1ProjectsProjectIdZonesZoneIdRrsetsPost

RrsetResponseRrSet V1ProjectsProjectIdZonesZoneIdRrsetsPost(ctx, body, projectId, zoneId) Post record set

Post record set

Required Parameters

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

Return type

RrsetResponseRrSet

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]

V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdDelete

SerializerMessage V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdDelete(ctx, projectId, zoneId, rrSetId) Delete a record set

Delete a record set

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
rrSetId	string	record set 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]

V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdGet

RrsetResponseRrSet V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdGet(ctx, projectId, zoneId, rrSetId) Get a single rrset

Get rrset

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
rrSetId	string	record set id

Return type

RrsetResponseRrSet

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]

V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdPatch

RrsetResponseRrSet V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdPatch(ctx, body, projectId, zoneId, rrSetId) Patch updates a record set

Patch record set

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	RrsetRrSetPatch	record set to patch
projectId	string	project id
zoneId	string	zone id
rrSetId	string	record set id

Return type

RrsetResponseRrSet

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]

V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdRecordsPatch

RrsetResponseRrSet V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdRecordsPatch(ctx, body, projectId, zoneId, rrSetId) PatchRecords updates a record in a rrset

PatchRecords rrset updates a record in a rrset

Required Parameters

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

Return type

RrsetResponseRrSet

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]

V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdRestoresPost

SerializerMessage V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdRestoresPost(ctx, projectId, zoneId, rrSetId) Restore record set

Restore record set

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
rrSetId	string	record set 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]