Skip to content

DomainApi

All URIs are relative to http://localhost

Method HTTP request Description
deleteApiDomainDelete DELETE /api/domain Delete
deleteDomainDeleteDelete DELETE /domain/delete Delete
getDomainsApiDomainsGet GET /api/domains Get Domains
getDomainsDomainGetGet GET /domain/get Get Domains
isAvailableApiDomainAvailableGet GET /api/domain/available Is Available
isAvailableDomainAvailableGet GET /domain/available Is Available
modifyApiDomainPatch PATCH /api/domain Modify
modifyDomainModifyPatch PATCH /domain/modify Modify
registerApiDomainPost POST /api/domain Register
registerDomainRegisterPost POST /domain/register Register

deleteApiDomainDelete

oas_any_type_not_mapped deleteApiDomainDelete(domain, type)

Delete

Parameters

Name Type Description Notes
domain String [default to null]
type String [optional] [default to null]

Return type

oas_any_type_not_mapped

Authorization

No authorization required

HTTP request headers

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

deleteDomainDeleteDelete

oas_any_type_not_mapped deleteDomainDeleteDelete(domain, type, Authorization)

Delete

Parameters

Name Type Description Notes
domain String [default to null]
type String [optional] [default to null]
Authorization String [optional] [default to null]

Return type

oas_any_type_not_mapped

Authorization

No authorization required

HTTP request headers

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

getDomainsApiDomainsGet

List getDomainsApiDomainsGet()

Get Domains

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

No authorization required

HTTP request headers

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

getDomainsDomainGetGet

DomainRetrieve getDomainsDomainGetGet(Authorization)

Get Domains

Parameters

Name Type Description Notes
Authorization String [optional] [default to null]

Return type

DomainRetrieve

Authorization

No authorization required

HTTP request headers

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

isAvailableApiDomainAvailableGet

oas_any_type_not_mapped isAvailableApiDomainAvailableGet(name)

Is Available

Check whether a domain is available. No authentication required

Parameters

Name Type Description Notes
name String [default to null]

Return type

oas_any_type_not_mapped

Authorization

No authorization required

HTTP request headers

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

isAvailableDomainAvailableGet

oas_any_type_not_mapped isAvailableDomainAvailableGet(name)

Is Available

Parameters

Name Type Description Notes
name String [default to null]

Return type

oas_any_type_not_mapped

Authorization

No authorization required

HTTP request headers

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

modifyApiDomainPatch

oas_any_type_not_mapped modifyApiDomainPatch(DomainType)

Modify

Parameters

Name Type Description Notes
DomainType DomainType

Return type

oas_any_type_not_mapped

Authorization

No authorization required

HTTP request headers

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

modifyDomainModifyPatch

oas_any_type_not_mapped modifyDomainModifyPatch(DomainType, Authorization)

Modify

Parameters

Name Type Description Notes
DomainType DomainType
Authorization String [optional] [default to null]

Return type

oas_any_type_not_mapped

Authorization

No authorization required

HTTP request headers

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

registerApiDomainPost

oas_any_type_not_mapped registerApiDomainPost(DomainType)

Register

Parameters

Name Type Description Notes
DomainType DomainType

Return type

oas_any_type_not_mapped

Authorization

No authorization required

HTTP request headers

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

registerDomainRegisterPost

oas_any_type_not_mapped registerDomainRegisterPost(DomainType, Authorization)

Register

Parameters

Name Type Description Notes
DomainType DomainType
Authorization String [optional] [default to null]

Return type

oas_any_type_not_mapped

Authorization

No authorization required

HTTP request headers

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