Note: Beagle Security API v1 has been deprecated. We recommend that you upgrade to v2
Get domain verification signature
Used to get the signature for domain verification process.
API
GEThttps://api.beaglesecurity.com/rest/v2/applications/signature?application_token={application_token}
Required scope: signature_verify
Request headers
| Name | Value |
|---|---|
| Authorization | Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
Request parameter
| Name | Type | Description | Required |
|---|---|---|---|
| application_token | string | A unique token for identifying the application in your account |
Example request
curl --location --request GET \
'https://api.beaglesecurity.com/rest/v2/applications/signature?application_token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
// This token will be generated from Beagle security settings -> Access token
BeagleSecurityClient client = BeagleSecurityClientBuilder.instance()
.withAPIToken("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")
.build();
// Get domain verification signature
String applicationToken = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
Signature signature = client.getSignature(applicationToken);
Response
| Name | Type | Description |
|---|---|---|
| status | string | Used to know the domain verification status of the application |
| url | string | URL of the application |
| code | string |
Status code for the API call.
Values are:
SUCCESSAPI call is success
PLAN_NOT_SUPPORTEDYour plan does not support this feature.
PROJECT_ALREADY_EXISTSProject already exists in your account.
INVALID_SESSIONInvalid session
FAILEDFailed to create project.
NOT_AUTHORIZEDUser authentication failed.
|
| message | string | Success/failure message for the API call |
| fileSignature | object | Object contains file verification details |
| dnsSignature | object | Object contains dns verification details |
| apiSignature | object | Object contains api verification details |
Example response
{
"status": "NotVerified",
"url": "https://example.com",
"code": "SUCCESS",
"message": "Success.",
"fileSignature": {
"signature": "_6r9lcxjztpnlps4sby648drxmz02zdlb"
},
"dnsSignature": {
"type": "TXT",
"name": "_31tervvaz40jy7bn543hux0hji296ovd",
"value": "_6r9lcxjztpnlps4sby648drxmz02zdlb"
},
"apiSignature": {
"type": "API",
"path": "_31tervvaz40jy7bn543hux0hji296ovd",
"value": "_6r9lcxjztpnlps4sby648drxmz02zdlb"
}
}
{
"code": "INVALID_SESSION",
"message": "Given token is invalid."
}
{
"code": "NOT_AUTHORIZED",
"message": "Not authorized"
}