DomainsApi.md

\DomainsApi

All URIs are relative to https://core.hivelocity.net/api/v2

Method	HTTP request	Description
DeleteARecordIdResource	Delete /domains/{domain}/a-record/{record}	Delete a single A Record value for given zone
DeleteAaaaRecordIdResource	Delete /domains/{domainID}/aaaa-record/{recordId}	Delete an AAAA Record for given zone
DeleteDomainIdResource	Delete /domains/{domainId}	Delete domain for given id
DeleteMxRecordIdResource	Delete /domains/{domainID}/mx-record/{recordId}	Delete an MX Record for given zone
GetARecordIdResource	Get /domains/{domain}/a-record/{record}	Return Single A Records found for given domain name
GetARecordResource	Get /domains/{domain}/a-record	Return all A Records found for given zone name
GetAaaaRecordIdResource	Get /domains/{domainID}/aaaa-record/{recordId}	Return Single AAAA Records found for given id
GetAaaaRecordResource	Get /domains/{domainID}/aaaa-record	Return all AAAA Records found for given zone
GetDomainIdResource	Get /domains/{domainId}	Return a domain for given id
GetDomainResource	Get /domains/	Return the domains of a client
GetMxRecordIdResource	Get /domains/{domainID}/mx-record/{recordId}	Return Single MX Records found for given id
GetMxRecordResource	Get /domains/{domainID}/mx-record	Return all MX Records found for given zone
GetPtrRecordIdResource	Get /domains/ptr/{recordId}	Get PTR record by ID and name
GetPtrRecordResource	Get /domains/ptr	Return the PTR records of a client
PostARecordResource	Post /domains/{domain}/a-record	Create a new A Record for given zone
PostAaaaRecordResource	Post /domains/{domainID}/aaaa-record	Create a new AAAA Record for given zone
PostDomainResource	Post /domains/	Create a new domain
PostMxRecordResource	Post /domains/{domainID}/mx-record	Create a new MX Record for given zone
PutARecordIdResource	Put /domains/{domain}/a-record/{record}	Update an A Record for given zone
PutAaaaRecordIdResource	Put /domains/{domainID}/aaaa-record/{recordId}	Update an AAAA Record for given id
PutMxRecordIdResource	Put /domains/{domainID}/mx-record/{recordId}	Update an MX Record for given zone
PutPtrRecordIdResource	Put /domains/ptr/{recordId}	Update PTR record

DeleteARecordIdResource

DeleteARecordIdResource(ctx, domain, record) Delete a single A Record value for given zone

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domain	string
record	string

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

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

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

DeleteAaaaRecordIdResource

DeleteAaaaRecordIdResource(ctx, domainID, recordId) Delete an AAAA Record for given zone

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domainID	int32
recordId	int32

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

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

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

DeleteDomainIdResource

DeleteDomainIdResource(ctx, domainId) Delete domain for given id

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domainId	int32

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

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

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

DeleteMxRecordIdResource

DeleteMxRecordIdResource(ctx, domainID, recordId) Delete an MX Record for given zone

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domainID	int32
recordId	int32

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

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

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

GetARecordIdResource

ARecord GetARecordIdResource(ctx, domain, record, optional) Return Single A Records found for given domain name

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domain	string
record	string
optional	*DomainsApiGetARecordIdResourceOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DomainsApiGetARecordIdResourceOpts struct

Name	Type	Description	Notes

xFields | optional.String| An optional fields mask |

Return type

ARecord

Authorization

apiKey

HTTP request headers

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

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

GetARecordResource

[]ARecord GetARecordResource(ctx, domain, optional) Return all A Records found for given zone name

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domain	string
optional	*DomainsApiGetARecordResourceOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DomainsApiGetARecordResourceOpts struct

Name	Type	Description	Notes

xFields | optional.String| An optional fields mask |

Return type

[]ARecord

Authorization

apiKey

HTTP request headers

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

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

GetAaaaRecordIdResource

AaaaRecordReturn GetAaaaRecordIdResource(ctx, domainID, recordId, optional) Return Single AAAA Records found for given id

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domainID	int32
recordId	int32
optional	*DomainsApiGetAaaaRecordIdResourceOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DomainsApiGetAaaaRecordIdResourceOpts struct

Name	Type	Description	Notes

xFields | optional.String| An optional fields mask |

Return type

AaaaRecordReturn

Authorization

apiKey

HTTP request headers

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

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

GetAaaaRecordResource

[]AaaaRecordReturn GetAaaaRecordResource(ctx, domainID, optional) Return all AAAA Records found for given zone

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domainID	int32
optional	*DomainsApiGetAaaaRecordResourceOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DomainsApiGetAaaaRecordResourceOpts struct

Name	Type	Description	Notes

xFields | optional.String| An optional fields mask |

Return type

[]AaaaRecordReturn

Authorization

apiKey

HTTP request headers

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

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

GetDomainIdResource

DomainReturn GetDomainIdResource(ctx, domainId, optional) Return a domain for given id

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domainId	int32
optional	*DomainsApiGetDomainIdResourceOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DomainsApiGetDomainIdResourceOpts struct

Name	Type	Description	Notes

xFields | optional.String| An optional fields mask |

Return type

DomainReturn

Authorization

apiKey

HTTP request headers

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

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

GetDomainResource

[]DomainReturn GetDomainResource(ctx, optional) Return the domains of a client

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*DomainsApiGetDomainResourceOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DomainsApiGetDomainResourceOpts struct

Name	Type	Description	Notes
xFields	optional.String	An optional fields mask

Return type

[]DomainReturn

Authorization

apiKey

HTTP request headers

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

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

GetMxRecordIdResource

MxRecordReturn GetMxRecordIdResource(ctx, domainID, recordId, optional) Return Single MX Records found for given id

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domainID	int32
recordId	int32
optional	*DomainsApiGetMxRecordIdResourceOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DomainsApiGetMxRecordIdResourceOpts struct

Name	Type	Description	Notes

xFields | optional.String| An optional fields mask |

Return type

MxRecordReturn

Authorization

apiKey

HTTP request headers

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

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

GetMxRecordResource

[]MxRecordReturn GetMxRecordResource(ctx, domainID, optional) Return all MX Records found for given zone

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domainID	int32
optional	*DomainsApiGetMxRecordResourceOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DomainsApiGetMxRecordResourceOpts struct

Name	Type	Description	Notes

xFields | optional.String| An optional fields mask |

Return type

[]MxRecordReturn

Authorization

apiKey

HTTP request headers

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

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

GetPtrRecordIdResource

PtrRecordReturn GetPtrRecordIdResource(ctx, recordId, optional) Get PTR record by ID and name

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
recordId	int32
optional	*DomainsApiGetPtrRecordIdResourceOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DomainsApiGetPtrRecordIdResourceOpts struct

Name	Type	Description	Notes

xFields | optional.String| An optional fields mask |

Return type

PtrRecordReturn

Authorization

apiKey

HTTP request headers

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

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

GetPtrRecordResource

[]PtrRecordReturn GetPtrRecordResource(ctx, optional) Return the PTR records of a client

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*DomainsApiGetPtrRecordResourceOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DomainsApiGetPtrRecordResourceOpts struct

Name	Type	Description	Notes
xFields	optional.String	An optional fields mask

Return type

[]PtrRecordReturn

Authorization

apiKey

HTTP request headers

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

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

PostARecordResource

ARecord PostARecordResource(ctx, domain, payload, optional) Create a new A Record for given zone

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domain	string
payload	ARecord
optional	*DomainsApiPostARecordResourceOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DomainsApiPostARecordResourceOpts struct

Name	Type	Description	Notes

xFields | optional.String| An optional fields mask |

Return type

ARecord

Authorization

apiKey

HTTP request headers

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

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

PostAaaaRecordResource

AaaaRecordReturn PostAaaaRecordResource(ctx, domainID, payload, optional) Create a new AAAA Record for given zone

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domainID	int32
payload	AaaaRecordCreate
optional	*DomainsApiPostAaaaRecordResourceOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DomainsApiPostAaaaRecordResourceOpts struct

Name	Type	Description	Notes

xFields | optional.String| An optional fields mask |

Return type

AaaaRecordReturn

Authorization

apiKey

HTTP request headers

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

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

PostDomainResource

DomainReturn PostDomainResource(ctx, payload, optional) Create a new domain

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
payload	DomainCreate
optional	*DomainsApiPostDomainResourceOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DomainsApiPostDomainResourceOpts struct

Name	Type	Description	Notes

xFields | optional.String| An optional fields mask |

Return type

DomainReturn

Authorization

apiKey

HTTP request headers

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

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

PostMxRecordResource

MxRecordReturn PostMxRecordResource(ctx, domainID, payload, optional) Create a new MX Record for given zone

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domainID	int32
payload	MxRecordCreate
optional	*DomainsApiPostMxRecordResourceOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DomainsApiPostMxRecordResourceOpts struct

Name	Type	Description	Notes

xFields | optional.String| An optional fields mask |

Return type

MxRecordReturn

Authorization

apiKey

HTTP request headers

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

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

PutARecordIdResource

ARecord PutARecordIdResource(ctx, domain, record, payload, optional) Update an A Record for given zone

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domain	string
record	string
payload	ARecord
optional	*DomainsApiPutARecordIdResourceOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DomainsApiPutARecordIdResourceOpts struct

Name	Type	Description	Notes

xFields | optional.String| An optional fields mask |

Return type

ARecord

Authorization

apiKey

HTTP request headers

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

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

PutAaaaRecordIdResource

AaaaRecordReturn PutAaaaRecordIdResource(ctx, domainID, recordId, payload, optional) Update an AAAA Record for given id

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domainID	int32
recordId	int32
payload	AaaaRecordUpdate
optional	*DomainsApiPutAaaaRecordIdResourceOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DomainsApiPutAaaaRecordIdResourceOpts struct

Name	Type	Description	Notes

xFields | optional.String| An optional fields mask |

Return type

AaaaRecordReturn

Authorization

apiKey

HTTP request headers

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

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

PutMxRecordIdResource

MxRecordReturn PutMxRecordIdResource(ctx, domainID, recordId, payload, optional) Update an MX Record for given zone

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domainID	int32
recordId	int32
payload	MxRecordUpdate
optional	*DomainsApiPutMxRecordIdResourceOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DomainsApiPutMxRecordIdResourceOpts struct

Name	Type	Description	Notes

xFields | optional.String| An optional fields mask |

Return type

MxRecordReturn

Authorization

apiKey

HTTP request headers

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

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

PutPtrRecordIdResource

PtrRecordReturn PutPtrRecordIdResource(ctx, recordId, payload, optional) Update PTR record

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
recordId	int32
payload	PtrRecordUpdate
optional	*DomainsApiPutPtrRecordIdResourceOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DomainsApiPutPtrRecordIdResourceOpts struct

Name	Type	Description	Notes

xFields | optional.String| An optional fields mask |

Return type

PtrRecordReturn

Authorization

apiKey

HTTP request headers

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

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