​
Overview

In this article, you will find information about submitting data via the Abusix API Data Channel. All data submitted via our RESTful API is mapped to the XARF format, short for the eXtended Abuse Reporting Format. XARF is a standardized set of schemas developed by the XARF community and Abusix for describing abusive behavior or content. The effort started as an open, community-driven initiative and has become an industry standard for sharing network abuse reports. The GitHub project provides free specifications to support end-to-end automation of abuse reporting.

​
Reporting Abusive Behavior to Abusix

When completing the Data Channel configuration steps in app.abusix.com, you may select Report Abusive Behavior to Abusix to both report abuse to the appropriate network owner and send data to your Guardian Ops instance. Examples of this use case include using AbuseHQ to manage abuse:
  • within your own hosted mail platform
  • user or admin authentication interfaces
  • hitting your firewalls
  • or other edge systems

​
Mapping Your Data with Our API

Our backbone uses the XARF schemas to route and process information. While most of the field names are intuitive, you can refer to the examples in the XARF GitHub Project to map your data correctly. If you need help with data mapping, contact us via chat or at support@abusix.com.

​
POST Your Data to the API

After completing the Data Channel configuration steps in app.abusix.com, you may POST your data. Our systems and support team will receive the data and take care of the rest.

​
Steps:

  1. Go to https://app.abusix.com/data-channels
  2. Create a Data Channel
  3. Send data into your AbuseHQ instance

​
Example: Send data using the XARF API

Send data using the XARF API

​
Example: Name your Data Channel

Name your data channel

​
Example: Access Credentials

Access credentials
⚠️ Replace any configuration pointing to https://abusix.abusehq.net/xarf/deliver with your new access credentials.

​
Example: curl Command

curl -vX POST https://datachannels.abusix.com/data/xarf \
     -d @copyright.json \
     --header "Content-Type: application/json" \
     --header "x-api-key: $YOURKEY"

{
  "Version": "2",
  "ReporterInfo": {
    "ReporterOrg": "ExampleOrg",
    "ReporterOrgDomain": "example.com",
    "ReporterOrgEmail": "reports@example.com"
  },
  "OnBehalfOf": {
    "ComplainantOrg": "ExampleComplainantOrg",
    "ComplainantOrgDomain": "complainant.example.com",
    "ComplainantOrgEmail": "complainant@complainant.example.com",
    "ComplainantContactEmail": "legal@complainant.example.com",
    "ComplainantContactName": "Legal Team",
    "ComplainantContactPhone": "0012345678"
  },
  "Disclosure": true,
  "Report": {
    "ReportType": "Copyright",
    "ReportClass": "Content",
    "FirstSeen": "2018-02-05T14:17:10Z",
    "Date": "2018-02-05T18:17:10Z",
    "SourceIp": "192.0.2.55",
    "SourcePort": 54321,
    "InfringedMaterial": "Example - Mr. Example",
    "SourceUrl": "http://www.badexample.com/badexapmplesong.mp3",
    "MaterialType": "Music",
    "FileName": "badexamplesong.mp3",
    "CourtOrder": "https://court.example.com/courtorder.pdf",
    "FileSize": 56,
    "FileHash": "somehashhere"
  }
}

​
API Responses

​
Status - 201 Created

{
  "state": "success",
  "id": "c8ee626c-add6-454d-a6ec-5302bd21fc37"
}

​
Status - 403 Forbidden

{
  "state": "error",
  "error": "permission denied"
}

​
Status - 400 Bad Request

{
  "state": "error",
  "error": "validation failed"
}

​
Status - 503 Service Unavailable

{
  "state": "error",
  "error": "The service is currently unavailable. Please try again later."
}

​
Need Help?

Having trouble with your setup or running into technical issues? Get in touch with our team of Abusix experts.