godaddy.abuse
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_godaddy.abuse_1.1.0.png)
ballerinax/godaddy.abuse Ballerina library
Overview
This is a generated connector for GoDaddy Abuse API v1 OpenAPI specification.
GoDaddy’s Abuse API is provided to simplify and standardize the abuse reporting experience.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create an GoDaddy account
- Obtain tokens
- Follow this link to obtain tokens
Clients![](/images/permalink.svg)
godaddy.abuse: Client![](/images/permalink.svg)
This is a generated connector for GoDaddy Certificates API v1 OpenAPI specification. 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 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.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials. Create a GoDaddy account and obtain tokens by following this guide.
init (ApiKeysConfig apiKeyConfig, ClientConfiguration clientConfig, string serviceUrl)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- clientConfig ClientConfiguration {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.ote-godaddy.com/" - URL of the target service
getTickets![](/images/permalink.svg)
function getTickets(string? 'type, boolean closed, string? sourceDomainOrIp, string? target, string? createdStart, string? createdEnd, int 'limit, int offset) returns AbuseTicketList|error
Lists all abuse tickets ids that match user provided filters
Parameters
- 'type string? (default ()) - The type of abuse.
- closed boolean (default false) - Is this abuse ticket closed?
- sourceDomainOrIp string? (default ()) - The domain name or ip address the abuse originated from
- target string? (default ()) - The brand/company the abuse is targeting. ie: brand name/bank name
- createdStart string? (default ()) - The earliest abuse ticket creation date to pull abuse tickets for
- createdEnd string? (default ()) - The latest abuse ticket creation date to pull abuse tickets for
- 'limit int (default 100) - Number of abuse ticket numbers to return.
- offset int (default 0) - The earliest result set record number to pull abuse tickets for
Return Type
- AbuseTicketList|error - Success
createTicket![](/images/permalink.svg)
function createTicket(AbuseTicketCreate payload) returns AbuseTicketId|error?
Creates a new abuse ticket.
Parameters
- payload AbuseTicketCreate - The endpoint which allows the Reporter to create a new abuse ticket
Return Type
- AbuseTicketId|error? - No response was specified
getTicketInfo![](/images/permalink.svg)
function getTicketInfo(string ticketId) returns AbuseTicket|error
Returns the abuse ticket data for a given ticket id.
Parameters
- ticketId string - A unique abuse ticket identifier
Return Type
- AbuseTicket|error - Success
Records![](/images/permalink.svg)
godaddy.abuse: AbuseTicket![](/images/permalink.svg)
The associated fields returned, given a unique abuse ticket id
Fields
- closed boolean - Is this abuse ticket closed?
- closedAt string - The date the abuse ticket was closed
- createdAt string - The date the abuse ticket was created
- domainIp string - The domain or IP the suspected abuse was reported against
- reporter string - The shopper id of the person who reported the suspected abuse
- 'source string - The single URL or IP the suspected abuse was reported against
- target string - The company the suspected abuse is targeting
- ticketId string - Abuse ticket ID
- 'type string - The type of abuse being reported
godaddy.abuse: AbuseTicketCreate![](/images/permalink.svg)
Fields
- info string? - Additional information that may assist the abuse investigator. ie: server logs or email headers/body for SPAM
- infoUrl string? - Reporter URL if housing additional information that may assist the abuse investigator
- intentional boolean? - Do you believe this is intentional abuse by the domain holder?
- proxy string? - The Proxy information required to view the abuse being reported. ie: Specific IP used, or country of IP viewing from
- 'source string? - The URL or IP where live abuse content is located at. ie: https://www.example.com/bad_stuff/bad.php
- target string? - The brand/company the abuse is targeting. ie: brand name/bank name
- 'type string? - The type of abuse being reported.
godaddy.abuse: AbuseTicketId![](/images/permalink.svg)
The primary key of a newly created abuse ticket
Fields
- u_number string? - Abuse ticket ID
godaddy.abuse: AbuseTicketList![](/images/permalink.svg)
Fields
- pagination Pagination? -
- ticketIds string[] - A list of abuse ticket ids originated by this reporter.
godaddy.abuse: ApiKeysConfig![](/images/permalink.svg)
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- authorization string - Represents API Key
Authorization
godaddy.abuse: Error![](/images/permalink.svg)
Fields
- code string - Short identifier for the error, suitable for indicating the specific error within client code
- fields ErrorField[]? - List of the specific fields, and the errors found with their contents
- message string? - Human-readable, English description of the error
- stack string[]? -
godaddy.abuse: ErrorField![](/images/permalink.svg)
Fields
- code string - Short identifier for the error, suitable for indicating the specific error within client code
- message string? - Human-readable, English description of the problem with the contents of the field
- path string -
- JSONPath referring to the field within the data containing an error<br/>or<br/>2) JSONPath referring to an object containing an error
- pathRelated string? - JSONPath referring to the field on the object referenced by
path
containing an error
godaddy.abuse: Pagination![](/images/permalink.svg)
Fields
- first string? - Optional link to first list of results
- last string? - Optional link to last list of results
- next string? - Optional link to next list of results
- previous string? - Optional link to previous list of results
- total int? - Number of records available
Import
import ballerinax/godaddy.abuse;
Metadata
Released date: over 2 years ago
Version: 1.1.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: slbeta6
GraalVM compatible: Yes
Pull count
Total: 1
Current verison: 0
Weekly downloads
Keywords
Business Intelligence/Reporting
Cost/Paid
Contributors
Dependencies