Skip to content

Latest commit

 

History

History
194 lines (111 loc) · 5.68 KB

ForwardsApi.md

File metadata and controls

194 lines (111 loc) · 5.68 KB

\ForwardsApi

All URIs are relative to https://api.domeneshop.no/v0

Method HTTP request Description
DomainsDomainIdForwardsGet Get /domains/{domainId}/forwards/ List forwards
DomainsDomainIdForwardsHostDelete Delete /domains/{domainId}/forwards/{host} Delete forward by host
DomainsDomainIdForwardsHostGet Get /domains/{domainId}/forwards/{host} Find forward by host
DomainsDomainIdForwardsHostPut Put /domains/{domainId}/forwards/{host} Update forward by host
DomainsDomainIdForwardsPost Post /domains/{domainId}/forwards/ Add forward

DomainsDomainIdForwardsGet

[]HttpForward DomainsDomainIdForwardsGet(ctx, domainId)

List forwards

List all forwards for the specified domain.

Required Parameters

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

Return type

[]HttpForward

Authorization

basicAuth

HTTP request headers

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

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

DomainsDomainIdForwardsHostDelete

DomainsDomainIdForwardsHostDelete(ctx, domainId, host)

Delete forward by host

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
domainId int32 ID of the domain
host string Subdomain of the forward, `@` for the root domain

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

DomainsDomainIdForwardsHostGet

HttpForward DomainsDomainIdForwardsHostGet(ctx, domainId, host)

Find forward by host

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
domainId int32 ID of the domain
host string Subdomain of the forward, `@` for the root domain

Return type

HttpForward

Authorization

basicAuth

HTTP request headers

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

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

DomainsDomainIdForwardsHostPut

HttpForward DomainsDomainIdForwardsHostPut(ctx, domainId, host, optional)

Update forward by host

Update a forwarding for the specified domain, to a given URL. The host field must not be changed. In that case, delete the existing forwarding and recreate it for the new host/subdomain.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
domainId int32 ID of the domain
host string Subdomain of the forward, `@` for the root domain
optional *DomainsDomainIdForwardsHostPutOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DomainsDomainIdForwardsHostPutOpts struct

Name Type Description Notes

httpForward | optional.Interface of HttpForward| |

Return type

HttpForward

Authorization

basicAuth

HTTP request headers

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

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

DomainsDomainIdForwardsPost

DomainsDomainIdForwardsPost(ctx, domainId)

Add forward

Create a forwarding for the specified domain, to a given URL. The forward must not collide with any existing forwarding or DNS record of types A, AAAA, ANAME or CNAME.

Required Parameters

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

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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