Registration
View as MarkdownRequest Body
application/json
Agent registration request
Registration request
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/agents/register" \ -H "Content-Type: application/json" \ -d '{ "agentDisplayName": "Sentiment Analyzer", "agentHost": "myagent.example.com", "endpoints": [ { "agentUrl": "https://myagent.example.com/mcp", "metaDataUrl": "https://myagent.example.com/.well-known/mcp.json", "documentationUrl": "https://docs.myagent.example.com", "protocol": "MCP", "transports": [ "STREAMABLE-HTTP" ], "functions": [ { "id": "domain_suggest", "name": "Domain Suggest", "tags": [ "domain", "suggestion", "availability" ] } ] } ], "identityCsrPEM": "string", "version": "1.2.0" }'{ "agentId": "550e8400-e29b-41d4-a716-446655440000", "ansName": "ans://v1.0.0.external-domain.com", "challenge": { "dnsRecord": { "name": "_acme-challenge.external-domain.com", "type": "TXT", "value": "xyz123abc456" }, "keyAuthorization": "xyz123abc456.thumbprint", "token": "xyz123abc456", "type": "DNS_01" }, "expiresAt": "2025-11-13 16:30:00+00:00", "links": [ { "href": "https://api.godaddy.com/v1/agents/550e8400-e29b-41d4-a716-446655440000/challenge", "rel": "challenge" } ], "nextSteps": [ { "action": "CONFIGURE_DNS", "description": "Configure DNS TXT record for ACME validation", "endpoint": "https://api.godaddy.com/v1/agents/550e8400-e29b-41d4-a716-446655440000/verify-acme" } ], "status": "PENDING_VALIDATION"}Path Parameters
Unique identifier of the agent
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/agents/string"{ "agentId": "550e8400-e29b-41d4-a716-446655440000", "agentDisplayName": "Sentiment Analyzer", "agentDescription": "An agent that analyzes sentiment in text", "agentHost": "myagent.example.com", "ansName": "ans://v1.0.0.myagent.example.com", "version": "1.0.0", "agentStatus": "ACTIVE", "endpoints": [ { "agentUrl": "https://myagent.example.com/mcp", "protocol": "MCP", "transports": [ "STREAMABLE-HTTP" ], "functions": [ { "id": "analyze_sentiment", "name": "Analyze Sentiment", "tags": [ "nlp", "sentiment" ] } ] }, { "agentUrl": "https://myagent.example.com/a2a", "metaDataUrl": "https://myagent.example.com/.well-known/agent-card.json", "protocol": "A2A", "transports": [ "JSON-RPC" ] }, { "agentUrl": "https://myagent.example.com/api/v1", "protocol": "HTTP-API", "transports": [ "REST" ], "documentationUrl": "https://docs.myagent.example.com/api" } ], "links": [ { "href": "https://api.godaddy.com/v1/agents/550e8400-e29b-41d4-a716-446655440000", "rel": "self" } ]}Last updated on
How is this guide?