GET api/Domain/{handle}/Authcode?cancel={cancel}&user={user}

Request authcode for a domain

Request Information

URI Parameters

Name	Description	Type	Additional information
handle	Domain handle	string	Required
cancel	optional - set to true to cancel current authcode (eu only)	boolean	None.
user	Optional user handle - if empty logged in user will be used	string	None.

Body Parameters

None.

Response Information

Resource Description

Object containing the auth code or a message Collection of errors on failure
Return codes
200 - ok
204 - command succeeded but doesn't return the code
401 - unauthorized
404 - not found
500 - internal server error
525 - object registered
558 - No AuthCode for this extension
580 - registry unreachable
581 - command failed
500 - internal server error

AuthcodeResponse

Name	Description	Type	Additional information
Authcode	Auth code if returned by registry	string	None.
AuthcodeExpires	Date the authcode expires (eu only)	date	None.
Message	Message indicating the auth code sent to owner	string	None.
Errors	List of errors with details if errors occured. 204 - no content - call succeeded but authcode is not returned 525 - object registered - authcode has already been issued, try GET domain 581 - command failed	Collection of Error	None.

Response Formats

application/json, text/json

Sample:

{
  "Authcode": "sample string 1",
  "AuthcodeExpires": "2025-04-04T00:24:00.1811484+02:00",
  "Message": "sample string 2",
  "Errors": [
    {
      "Code": 1,
      "Detail": "sample string 2",
      "Data": {}
    }
  ]
}

application/xml, text/xml

Sample:

<AuthcodeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Domain">
  <Authcode>sample string 1</Authcode>
  <AuthcodeExpires>2025-04-04T00:24:00.1811484+02:00</AuthcodeExpires>
  <Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models">
    <d2p1:Error>
      <d2p1:Code>1</d2p1:Code>
      <d2p1:Data />
      <d2p1:Detail>sample string 2</d2p1:Detail>
    </d2p1:Error>
  </Errors>
  <Message>sample string 2</Message>
</AuthcodeResponse>