From 4a75fc228ce1dc1d959332b271d09fa4a70b7d86 Mon Sep 17 00:00:00 2001 From: Fernanda Date: Fri, 27 Mar 2026 11:03:26 -0300 Subject: [PATCH 1/3] W-21743430-goddady-fa --- modules/ROOT/pages/godaddy-overview.adoc | 75 ++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 modules/ROOT/pages/godaddy-overview.adoc diff --git a/modules/ROOT/pages/godaddy-overview.adoc b/modules/ROOT/pages/godaddy-overview.adoc new file mode 100644 index 00000000..4d0216ec --- /dev/null +++ b/modules/ROOT/pages/godaddy-overview.adoc @@ -0,0 +1,75 @@ += Register Agents with GoDaddy ANS + +GoDaddy Agent Name Service (ANS) integration enables you to register and verify agents deployed through API Manager. +Registration associates your agent with a verified domain and allows Anypoint Exchange to display a verified status for the asset. + +This integration introduces a registration workflow in API Manager that communicates with GoDaddy to validate domain ownership and agent identity. + +== Capabilities + +With GoDaddy ANS integration in API Manager, you can: + +* Register an agent instance with GoDaddy ANS +* Track the registration status directly from API Manager +* Retry or restart registration if it fails or expires +* Verify agents associated with your domain +* Surface verification status in Anypoint Exchange + +== Registration Workflow + +The registration workflow spans API Manager, GoDaddy, and Anypoint Exchange: + +1. You initiate registration from an API instance in API Manager. +2. API Manager sends a registration request to GoDaddy ANS. +3. GoDaddy validates domain ownership using DNS or ACME challenges. +4. API Manager tracks and updates the registration status. +5. Once verification is complete, the agent is marked as verified. +6. Anypoint Exchange displays the verified status for the asset. + +The exact validation process depends on the domain type used by the agent. + +== Supported Domain types + +The registration experience varies depending on the domain associated with the agent: + +* *MuleSoft-managed domains*: +API Manager automatically handles DNS configuration and verification. + +* *Custom domains*: +You must manually configure DNS records to complete verification. +If verification is not completed within the allowed time window, the registration expires and must be restarted. + +== Registration status + +During registration, API Manager tracks the status of the verification process. +Common states include: + +* Pending validation +* Waiting for DNS configuration +* Active (verified) +* Failed +* Expired + +You can monitor the current status and take action, such as retrying the process, directly from API Manager. + +== Integration with Anypoint Exchange + +Verification status is reflected in Anypoint Exchange: + +* Verified agents display a visual indicator in search results and asset pages +* Verification is tied to the agent instance and its associated domain +* Only successfully verified agents are marked as verified + +== Before you begin + +Before registering an agent, make sure that: + +* The API instance is deployed and accessible +* A valid consumer endpoint is configured +* Required credentials for GoDaddy ANS are available +* You have permissions to manage the API instance and related secrets + +== See also + +* xref:api-manager::index.adoc[API Manager Overview] +* xref:exchange::index.adoc[Anypoint Exchange] \ No newline at end of file From 8e42e902abd49ba3c591333b2cac2f25b1a3595a Mon Sep 17 00:00:00 2001 From: Fernanda Date: Fri, 27 Mar 2026 11:09:04 -0300 Subject: [PATCH 2/3] Create godaddy-register-agent.adoc --- .../ROOT/pages/godaddy-register-agent.adoc | 60 +++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 modules/ROOT/pages/godaddy-register-agent.adoc diff --git a/modules/ROOT/pages/godaddy-register-agent.adoc b/modules/ROOT/pages/godaddy-register-agent.adoc new file mode 100644 index 00000000..db803994 --- /dev/null +++ b/modules/ROOT/pages/godaddy-register-agent.adoc @@ -0,0 +1,60 @@ += Register an agent + +Register an agent to verify its domain and enable its verified status in Anypoint Exchange. +Registration is initiated from an API instance in API Manager and requires validating domain ownership through GoDaddy ANS. + +== Requirements + +Before you begin, ensure that: + +* The API instance is deployed and accessible +* A valid consumer endpoint is configured for the agent +* You have access to the required GoDaddy ANS credentials +* You have permissions to manage the API instance and related secrets + +== Register an agent + +. In Anypoint Platform, go to *API Manager*. +. Select the API instance that represents your agent. +. In the instance details, locate the *Agent registration* section. +. Click *Register agent*. +. Provide the required configuration: ++ +* *Consumer endpoint*: The public endpoint used for verification +* *Credentials*: The secret group or credentials required for GoDaddy ANS ++ +. Click *Submit* to start the registration process. + +API Manager initiates the registration request and displays the current registration status. + +== Complete domain verification + +Depending on the domain type, verification is completed differently: + +* *MuleSoft-managed domains*: +Verification is handled automatically. No additional action is required. + +* *Custom domains*: +You must create the required DNS records to complete verification. +Use the values provided in API Manager to configure your DNS provider. + +Verification must be completed within the allowed time window. If verification expires, you must restart the registration process. + +== Monitor registration status + +After submitting the registration: + +* View the current status in the *Agent registration* section +* Wait for the status to transition to *Active* after successful verification +* If the process fails or expires, use the available option to retry or restart registration + +For more information about registration states, see xref:registration-states.adoc[Registration states]. + +== Next steps + +After the agent is successfully registered: + +* Confirm that the agent displays as verified in Anypoint Exchange +* Review the asset details and ensure the verified status is visible + +For more information, see xref:integration-exchange.adoc[Integration with Anypoint Exchange]. \ No newline at end of file From 6772f4e43d7a2b35ad66c00def90feb8fb78b235 Mon Sep 17 00:00:00 2001 From: Fernanda Date: Fri, 27 Mar 2026 11:24:56 -0300 Subject: [PATCH 3/3] W-21743430-goddady-fa --- modules/ROOT/pages/godaddy-register-agent.adoc | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/modules/ROOT/pages/godaddy-register-agent.adoc b/modules/ROOT/pages/godaddy-register-agent.adoc index db803994..1d273350 100644 --- a/modules/ROOT/pages/godaddy-register-agent.adoc +++ b/modules/ROOT/pages/godaddy-register-agent.adoc @@ -5,7 +5,7 @@ Registration is initiated from an API instance in API Manager and requires valid == Requirements -Before you begin, ensure that: +Before you begin, make sure that: * The API instance is deployed and accessible * A valid consumer endpoint is configured for the agent @@ -21,8 +21,8 @@ Before you begin, ensure that: . Provide the required configuration: + * *Consumer endpoint*: The public endpoint used for verification -* *Credentials*: The secret group or credentials required for GoDaddy ANS -+ +* *Credentials*: The GoDaddy API key and secret required for registration. + +Generate these credentials in your GoDaddy account and provide them during registration. . Click *Submit* to start the registration process. API Manager initiates the registration request and displays the current registration status. @@ -48,8 +48,6 @@ After submitting the registration: * Wait for the status to transition to *Active* after successful verification * If the process fails or expires, use the available option to retry or restart registration -For more information about registration states, see xref:registration-states.adoc[Registration states]. - == Next steps After the agent is successfully registered: @@ -57,4 +55,4 @@ After the agent is successfully registered: * Confirm that the agent displays as verified in Anypoint Exchange * Review the asset details and ensure the verified status is visible -For more information, see xref:integration-exchange.adoc[Integration with Anypoint Exchange]. \ No newline at end of file +For more information, see xref:placeholderside[Integration with Anypoint Exchange]. \ No newline at end of file