swagger: '2.0' info: title: Abuse Actions API version: 2.0.0 description: GoDaddy Abuse API Terms of Use:

GoDaddy’s Abuse API is provided to simplify and standardize the abuse reporting experience. To help us streamline the review of abuse reports, you acknowledge and agree that your use of GoDaddy’s Abuse API is subject to the following quality metrics and terms of use.

GoDaddy may, in its sole and absolute discretion, change or modify these terms, and such changes or modifications shall be effective immediately upon notice to you. Your use of GoDaddy’s Abuse API after such changes or modifications shall constitute your acceptance of these terms as last revised. If you do not agree to be bound by these terms as last revised, do not use (or continue to use) our Abuse API.

As an Abuse API user, you must only submit abuse reports via the API portal and cease all email submissions, including but not limited, to phishing@godaddy.com, netabuse@godaddy.com, malware@godaddy.com, or spam@godaddy.com, etc. Any additional or duplicate submission outside of the API portal will be deprioritized for review. Submissions related to trademark, copyright or content issues may still be sent to trademarkclaims@godaddy.com, coyprightclaims@godaddy.com, and contentcomplaints@godaddy.com, respectively. Our [Front of Site](https://supportcenter.godaddy.com/AbuseReport) also describes other scenarios not covered by the API.

When you submit abuse reports via GoDaddy’s Abuse API, you must ensure that you accurately categorize the abuse type of each report to match our definitions in the API documentations provided to you. Any submission that fails to match our definitions or is miscategorized will be marked as a false positive. Examples include, but are not limited to, submissions of trademark complaints marked as phishing or malware, or submissions of copyright complaints marked as phishing or malware, etc.

If, at any time, the false positive rate of submissions exceeds 40% of your total submissions, as determined by GoDaddy, GoDaddy may in its sole discretion deprioritize any subsequent reports submitted by you and/or your organization.

You acknowledge and agree that submitting every URL for a single domain is not necessary and will not expedite the review process. If your submissions exceed five (5) URLs for a single domain, your report will be marked as a duplicate submission taking into account that the final outcome of such submissions would yield the same result as the original report. GoDaddy may in its sole discretion deprioritize reports submitted by you and/or your organization in the event more than 20% of your submissions are classified as duplicate submissions.

You further acknowledge and agree that our Customer Support lines are not intended to address abuse reporting matters or your use of GoDaddy’s Abuse API. Contacting Customer Support will not expedite the review process and may result in abuse reports being deprioritized, to be determined in our sole discretion.

Should you have any questions about GoDaddy’s Abuse API or any of the terms and conditions set forth above, please contact abuseapisupport@godaddy.com.

host: api.ote-godaddy.com tags: - name: Actions description: '' paths: /v2/customers/{customerId}/domains/{domain}/actions: get: tags: - Actions produces: - application/json summary: Retrieves a list of the most recent actions for the specified domain parameters: - name: X-Request-Id required: false in: header type: string description: A client provided identifier for tracking this request. - description: 'The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you''re operating on behalf of; otherwise use your shopper id.' in: path name: customerId required: true type: string - description: Domain whose actions are to be retrieved name: domain in: path required: true type: string responses: '200': description: Request was successful schema: items: $ref: '#/definitions/Action' type: array '401': description: Authentication info not sent or invalid schema: $ref: '#/definitions/Error' '403': description: Authenticated user is not allowed access schema: $ref: '#/definitions/Error' '404': description: The domain does not exist schema: $ref: '#/definitions/Error' '429': description: Too many requests received within interval schema: $ref: '#/definitions/ErrorLimit' '500': description: Internal server error schema: $ref: '#/definitions/Error' /v2/customers/{customerId}/domains/{domain}/actions/{type}: delete: tags: - Actions consumes: - application/json produces: - application/json summary: Cancel the most recent user action for the specified domain parameters: - name: X-Request-Id required: false in: header type: string description: A client provided identifier for tracking this request. - description: 'The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you''re operating on behalf of; otherwise use your shopper id.' in: path name: customerId required: true type: string - description: Domain whose action is to be cancelled name: domain in: path required: true type: string - name: type description: The type of action to cancel in: path required: true type: string enum: - AUTH_CODE_PURCHASE - AUTH_CODE_REGENERATE - BACKORDER_PURCHASE - BACKORDER_DELETE - BACKORDER_UPDATE - CHANGE_OF_REGISTRANT_DELETE - DNSSEC_CREATE - DNSSEC_DELETE - DOMAIN_DELETE - DOMAIN_UPDATE - DOMAIN_UPDATE_CONTACTS - DOMAIN_UPDATE_NAME_SERVERS - MIGRATE - PRIVACY_FORWARDING_UPDATE - PRIVACY_PURCHASE - PRIVACY_DELETE - REDEEM - REGISTER - RENEW - RENEW_UNDO - TRADE - TRADE_CANCEL - TRADE_PURCHASE - TRADE_PURCHASE_AUTH_TEXT_MESSAGE - TRADE_RESEND_AUTH_EMAIL - TRANSFER - TRANSFER_IN_ACCEPT - TRANSFER_IN_CANCEL - TRANSFER_IN_RESTART - TRANSFER_IN_RETRY - TRANSFER_OUT_ACCEPT - TRANSFER_OUT_REJECT - TRANSFER_OUT_REQUESTED - TRANSIT responses: '204': description: Request was successful '401': description: Authentication info not sent or invalid schema: $ref: '#/definitions/Error' '403': description: Authenticated user is not allowed access schema: $ref: '#/definitions/Error' '404': description: The domain does not exist schema: $ref: '#/definitions/Error' '409': description: The action status does not allow performing the operation schema: $ref: '#/definitions/Error' '429': description: Too many requests received within interval schema: $ref: '#/definitions/ErrorLimit' '500': description: Internal server error schema: $ref: '#/definitions/Error' get: tags: - Actions produces: - application/json summary: Retrieves the most recent action for the specified domain parameters: - name: X-Request-Id required: false in: header type: string description: A client provided identifier for tracking this request. - description: 'The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you''re operating on behalf of; otherwise use your shopper id.' in: path name: customerId required: true type: string - description: Domain whose action is to be retrieved name: domain in: path required: true type: string - name: type description: The type of action to retrieve in: path required: true type: string enum: - AUTH_CODE_PURCHASE - AUTH_CODE_REGENERATE - AUTO_RENEWAL - BACKORDER_PURCHASE - BACKORDER_DELETE - BACKORDER_UPDATE - CHANGE_OF_REGISTRANT_DELETE - DNS_VERIFICATION - DNSSEC_CREATE - DNSSEC_DELETE - DOMAIN_DELETE - DOMAIN_UPDATE - DOMAIN_UPDATE_CONTACTS - DOMAIN_UPDATE_NAME_SERVERS - EXPIRY - ICANN_VERIFICATION - MIGRATE - MIGRATE_IN - PREMIUM - PRIVACY_FORWARDING_UPDATE - PRIVACY_PURCHASE - PRIVACY_DELETE - REDEEM - REGISTER - RENEW - RENEW_UNDO - TRADE - TRADE_CANCEL - TRADE_PURCHASE - TRADE_PURCHASE_AUTH_TEXT_MESSAGE - TRADE_RESEND_AUTH_EMAIL - TRANSFER - TRANSFER_IN - TRANSFER_IN_ACCEPT - TRANSFER_IN_CANCEL - TRANSFER_IN_RESTART - TRANSFER_IN_RETRY - TRANSFER_OUT - TRANSFER_OUT_ACCEPT - TRANSFER_OUT_REJECT - TRANSFER_OUT_REQUESTED - TRANSIT responses: '200': description: Request was successful schema: $ref: '#/definitions/Action' '401': description: Authentication info not sent or invalid schema: $ref: '#/definitions/Error' '403': description: Authenticated user is not allowed access schema: $ref: '#/definitions/Error' '404': description: The domain does not exist schema: $ref: '#/definitions/Error' '409': description: The domain status does not allow performing the operation schema: $ref: '#/definitions/Error' '429': description: Too many requests received within interval schema: $ref: '#/definitions/ErrorLimit' '500': description: Internal server error schema: $ref: '#/definitions/Error' definitions: ActionReason: additionalProperties: false properties: code: type: string format: constant pattern: ^[A-Z_][A-Z0-9_]*$ description: Short identifier, suitable for indicating the reason for the current status and how to handle within client code message: type: string description: Human-readable, English description of the code fields: type: array items: $ref: '#/definitions/ErrorField' description: List of the specific fields, and the errors found with their contents required: - code Action: properties: type: type: string description: 'The type of action being performed
' enum: - AUTH_CODE_PURCHASE - AUTH_CODE_REGENERATE - AUTO_RENEWAL - BACKORDER_PURCHASE - BACKORDER_DELETE - BACKORDER_UPDATE - CHANGE_OF_REGISTRANT_DELETE - CONTACT_CREATE - CONTACT_DELETE - CONTACT_UPDATE - DNS_VERIFICATION - DNSSEC_CREATE - DNSSEC_DELETE - DOMAIN_DELETE - DOMAIN_UPDATE - DOMAIN_UPDATE_CONTACTS - DOMAIN_UPDATE_NAME_SERVERS - EXPIRY - HOST_CREATE - HOST_DELETE - ICANN_VERIFICATION - MIGRATE - MIGRATE_IN - PREMIUM - PRIVACY_FORWARDING_UPDATE - PRIVACY_PURCHASE - PRIVACY_DELETE - REDEEM - REGISTER - RENEW - RENEW_UNDO - TRADE - TRADE_CANCEL - TRADE_PURCHASE - TRADE_PURCHASE_AUTH_TEXT_MESSAGE - TRADE_RESEND_AUTH_EMAIL - TRANSFER - TRANSFER_IN - TRANSFER_IN_ACCEPT - TRANSFER_IN_CANCEL - TRANSFER_IN_RESTART - TRANSFER_IN_RETRY - TRANSFER_OUT - TRANSFER_OUT_ACCEPT - TRANSFER_OUT_REJECT - TRANSFER_OUT_REQUESTED - TRANSIT origination: type: string enum: - USER - SYSTEM description: 'The origination of the action
' createdAt: type: string format: iso-datetime description: Timestamp indicating when the action was created startedAt: type: string format: iso-datetime description: Timestamp indicating when the action was started completedAt: type: string format: iso-datetime description: Timestamp indicating when the action was completed modifiedAt: type: string format: iso-datetime description: Timestamp indicating when the action was last modified status: type: string default: ACCEPTED enum: - ACCEPTED - AWAITING - CANCELLED - FAILED - PENDING - SUCCESS description: 'The current status of the action
' reason: $ref: '#/definitions/ActionReason' description: The detailed reason for the status requestId: type: string description: A client provided identifier (via X-Request-Id header) used for tracking individual requests required: - type - origination - createdAt - status Error: properties: code: description: Short identifier for the error, suitable for indicating the specific error within client code format: constant type: string fields: description: List of the specific fields, and the errors found with their contents items: $ref: '#/definitions/ErrorField' type: array message: description: Human-readable, English description of the error type: string required: - code ErrorField: properties: code: description: Short identifier for the error, suitable for indicating the specific error within client code format: constant type: string message: description: Human-readable, English description of the problem with the contents of the field type: string path: description: '' format: json-path type: string pathRelated: description: JSONPath referring to a field containing an error, which is referenced by `path` format: json-path type: string required: - path - code ErrorLimit: properties: code: description: Short identifier for the error, suitable for indicating the specific error within client code format: constant type: string fields: description: List of the specific fields, and the errors found with their contents items: $ref: '#/definitions/ErrorField' type: array message: description: Human-readable, English description of the error type: string retryAfterSec: description: Number of seconds to wait before attempting a similar request format: integer-positive type: integer required: - retryAfterSec - code