Skip to content

ApiApi

All URIs are relative to http://localhost

Method HTTP request Description
createApiTokenApiCreateKeyPost POST /api/create-key Create Api Token
deleteApiDomainDelete DELETE /api/domain Delete
deleteApiKeyApiDeleteKeyDelete DELETE /api/delete-key Delete Api Key
getApiKeysApiGetKeysGet GET /api/get-keys Get Api Keys
getDomainsApiDomainsGet GET /api/domains Get Domains
getKeyApiGetKeyGet GET /api/get-key Get Key
getUserProfileApiUserGet GET /api/user Get User Profile
isAvailableApiDomainAvailableGet GET /api/domain/available Is Available
modifyApiDomainPatch PATCH /api/domain Modify
registerApiDomainPost POST /api/domain Register

createApiTokenApiCreateKeyPost

String createApiTokenApiCreateKeyPost(ApiCreationBody, Authorization)

Create Api Token

Parameters

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

Return type

String

Authorization

No authorization required

HTTP request headers

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

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

deleteApiKeyApiDeleteKeyDelete

oas_any_type_not_mapped deleteApiKeyApiDeleteKeyDelete(ApiDeletion, Authorization)

Delete Api Key

Parameters

Name Type Description Notes
ApiDeletion ApiDeletion
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

getApiKeysApiGetKeysGet

Map getApiKeysApiGetKeysGet(Authorization)

Get Api Keys

Parameters

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

Return type

Map

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

getKeyApiGetKeyGet

String getKeyApiGetKeyGet(hash, Authorization)

Get Key

Parameters

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

Return type

String

Authorization

No authorization required

HTTP request headers

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

getUserProfileApiUserGet

UserPageType getUserProfileApiUserGet()

Get User Profile

Parameters

This endpoint does not need any parameter.

Return type

UserPageType

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

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

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