api.xforce.ibmcloud.com Open in urlscan Pro
2606:4700::6811:5412  Public Scan

Form analysis
0 forms found in the DOM

Text Content

IBM X-Force Exchange API
Key Password Authenticate



IBM X-FORCE EXCHANGE API DOCUMENTATION

DOCUMENTATION PAGE REFRESHED USING SWAGGER 3.X. SCROLL DOWN FOR API DETAILS
PREVIOUSLY IN LEFT NAVIGATION BAR.



INTRODUCTION

The X-Force Exchange (XFE) API provides programmatic access to X-Force Exchange.
Each call in the API supports a capability in the UI of the X-Force Exchange
platform. The API follows guidelines for RESTful APIs, with the HTTP path
defining the service to the call and the resource being requested.

The API provides a limited free tier of access, for non-commercial use. If you
wish to use the API above the limit allowed, or for commercial use, please visit
our marketplace or contact your IBM sales representative to learn more.

Before you start, check out the Gentle Introduction to the X-Force Exchange API.
It includes links to open-source projects to access the API. In addition, there
is an IBM supported X-Force Exchange Node SDK.

Once you are authenticated, you have the flexibility to use it in the way that
best fits your particular use case.





INTERACTIVE DOCUMENTATION

This documentation uses Swagger to provide interactive API documentation. You
can try out all of the API calls from within this page by clicking the Try it
out! button in each API endpoint section below. To try out each call you will
need to provide an API Key and pasword in the fields at the top of this page.





AUTHENTICATION

You must have an IBM ID to use the XFE API. Register for an IBM ID at IBM id
registration. Once registered you will need to verify your account using the
token in the e-mail message that you receive.

When verified, login to X-Force Exchange then follow these steps to generate a
new API Key and Password:

1. View your Profile summary by clicking the User icon in the top right hand
corner of the X-Force Exchange Home Page.



2. Click the Settings link in the lower left corner to view the Settings Page,
then click the API Access link in the settings page to view the API details
page.



3. Click the Generate button to create a new API Key and Password.



Once you generate your password, makes sure to save it, as it is only shown when
the key/password is generated. When you revisit your profile again, only the key
is shown. Also, Your API key should not be shared, as it is specific to your ID.
Finally, API keys and passwords do not expire. If you forget your password, you
can generate a new API key/password pair.

Our API only allow HTTPS connections that support TLS protocol version 1.2 or
newer. All other connections will be rejected.





ERROR HANDLING

The X-Force Exchange API uses conventional HTTP response codes to indicate
success or failure of an API request. In general, codes in the 2xx range
indicate success, codes in the 4xx range indicate an error that resulted from
the provided information, and codes in the 5xx range indicate an error with our
servers.

A 402 response is returned for users who have exceeded their monthly quota of
records returned.





TERMS OF USE

Your use of the IBM X-Force Exchange is governed by the IBM Cloud Services
Agreement and the accompanying Service Description. You can find a copy of the
Cloud Services Agreement by visiting https://www.ibm.com/terms/, and selecting
your region, then your country, then the 'IBM Cloud Services Agreement' link.
You can find a copy of the Services Description by clicking on Service
Description. By using these services you agree to the terms of the IBM Cloud
Services Agreement and Service Description. If you do not agree with these
terms, do not use the IBM X-Force Exchange.





ABUSE

IBM reserves the right to disable any account deemed abusing our system.
Abuse-related activity includes, but is not limited to sharing accounts, bulk
registrations, abuse of API calls, suspicious/malicious query parameters and
accessing restricted resources. Additionally, users are expected to follow our
limiting practices as outlined in the HTTP responses.

To avoid limiting errors, no more than 3,000 requests should be made in a one
minute period to the X-Force Exchange API.





RECORD

A record is an element of data affiliated with an API Call. For example, if an
endpoint returns 80 results, you will be ‘billed’ 80 records on your API usage.

More information regarding the allocation for each tier of account is available
at the following link: Tiers of Usage





CONTACT DETAILS

Created by X-Force API Support



Contact the developer


X-FORCE EXCHANGE APIS

Servers
/api



ADVANCED THREAT PROTECTION FEED

PROVIDES ACCESS TO THE LATEST THREAT SPECIFIC AND ACTIONABLE INDICATORS,
INCLUDING EARLY WARNING DATA. MORE INFO




ADVANCED THREAT PROTECTION FEED TAXII

OFFERS SECURE TRANSPORTATION AND INTERCHANGE OF THREAT INTELLIGENCE INFORMATION.
MORE INFO




ADVANCED THREAT PROTECTION FEED TAXII2

PROVIDES ACCESS TO THE LATEST THREAT SPECIFIC AND ACTIONABLE INDICATORS VIA
TAXII 2.0 MORE INFO




APP EXCHANGE

RETURNS INFORMATION ON ALL THE EXTENSIONS OR APPS IN IBM APP EXCHANGE.




AUTHENTICATION

COPY AND PASTE API KEY AND PASSWORD IN THE HEADER FIELDS ABOVE TO TRY OUT ALL
THE ENDPOINTS INTERACTIVELY HERE. MORE INFO




COLLECTIONS

PROVIDES A WAY TO SHARE AND COLLABORATE ON EXISTING AND EMERGING SECURITY
THREATS. MORE INFO




DNS

RETRIEVES DNS INFORMATION FOR DOMAIN NAMES, URLS AND IP ADDRESSES. MORE INFO




EARLY WARNING

PROVIDES DEEP DIVE ON A DOMAIN, WHOIS INFO, CREATION DATE, AND SPAM / PHISHING /
MALWARE TIES.




INDUSTRIES

RETRIEVES AN INDUSTRY-BASED VIEW OF THE THREAT LANDSCAPE. MORE INFO




INTERNET APPLICATION PROFILE

RETURNS INFORMATION ON IAPS FOR SERVICES SUCH AS FACEBOOK, NFL.COM AND
INSTAGRAM, AMONG THE REPUTABLE. MORE INFO




IP REPUTATION

RETRIEVES IP ADDRESS, GEOLOCATION, RISK RATINGS AND CONTENT CATEGORIZATION FOR
IP ADDRESSES AND SUBNETS. MORE INFO




MALWARE

RETRIEVES DETAILS ON MALWARE IDENTIFIED BY NAME, FAMILY OR FILE HASH. MORE INFO




MALWARE ANALYSIS

PROVIDES AN IN-DEPTH DESCRIPTION OF HOW THE MALWARE FUNCTIONS, INDICATORS OF
COMPROMISE, PAYLOADS, MUTEXES, AND PROCESSES. MORE INFO




SIGNATURES

PERFORMS FULL-TEXT SEARCH OF THE SIGNATURE DEFINITIONS, RETRIEVE SIGNATURE
DETAILS, AND MORE.




STIX EXPORT

EXPORTS SOME OBJECTS IN THE STIX FORMAT.




TAGS

PROVIDES A WAY TO CONNECT COLLECTIONS AND REPORTS WITH BUZZWORDS.




TAXII

TAXII SUPPORTS STIX-FORMATTED CONTENT, AND CAN ALSO TRANSPORT INFORMATION
SECURELY IN A WIDE VARIETY OF FORMATS. MORE INFO




TAXII2

EXCHANGES CYBER THREAT INTELLIGENCE (CTI) OVER HTTPS, WITH ADDITIONAL
FLEXIBILITY IN TAXII 2.0 MORE INFO




THREAT ACTIVITIES

RETRIEVES DETAILS OF NEW AND EXISTING THREAT ACTIVITY REPORTS.




THREAT GROUPS

PROFILES LATEST INFORMATION ABOUT CYBER THREAT GROUPS TRACKED WITHIN IBM AS AN
IBM X-FORCE TRACKED GROUP (ITG). MORE INFO




URL

RETRIEVES URL RISK RATINGS, CONTENT CATEGORIES AND MALWARE INFORMATION,
COMPLEMENTING THE IP ADDRESS AND DOMAIN QUERIES. MORE INFO




USAGE

REQUESTS THE NUMBER OF RECORDS RETURNED USING THESE SUBSCRIPTIONS. MORE INFO




USER

RETURNS INFORMATION ABOUT THE USER’S PROFILE




VERSION INFORMATION

RETURNS INFORMATION ON THE CURRENT RUNNING API VERSION




VULNERABILITIES

PROVIDES DETAILS ON A VULNERABILITY AND LINKS TO RELEVANT ONLINE DOCUMENTS AND
CVSS SCORING WITH COMPONENT BREAKDOWN. MORE INFO




WHOIS

RETURNS THE WHOIS INFORMATION FOR AN IP, URL OR DOMAIN.



SCHEMAS