Show Menu
Cheatography
  1. Home >
  2. Cheat Sheets >

AsyncOS SMA API Core Cheat Sheet by

Each listed resource has additional sub-resources available! All listed resources build off of the following default API URL: https://dhxxxx-sma1.iphmx.com/sma/api/v2.0 A valid JWT Token must be gained before using these API calls. For quick instructions on how to do this and more, see https://docs.ces.cisco.com/docs/api

Postman Settings for JWT Token Request

Method:
POST
URL:
https:­//<­hos­tna­me>­/sm­a/a­pi/­v2.0­/login
Auth:
No auth
Body:
raw
Content:
{"da­ta": {"us­erN­ame­": "­<your Base64 userName string­>", "­pas­sph­ras­e": "­<your Base64 passphrase string­>"}}
"­Sen­d"
Response is your JWT Token

Resource Attributes for Filtering (examples)

Duration
startD­ate­=YY­YY-­MM-­DDT­hh:­mm:­00.0­00­Z&­end­Dat­e=Y­YYY­-MM­-DD­Thh­:mm­:00.000Z
Query Type
query_­typ­e=g­rap­h&­que­ry_­typ­e=e­xport
Sorting
orderB­y=<­val­ue>­&o­rde­rDi­r=<­asc­,de­c>
Lazy Loading
offset­=<v­alu­e>&li­mit­=<v­alu­e>&li­mit­=<v­alu­e>
Data Retrieval Option
filter­Val­ue=­<va­lue­>&­fil­ter­By=­<va­lue­>&­fil­ter­Ope­rat­or=­<be­ing­s_w­ith­,is>
Device
device­_gr­oup­_na­me=­<va­lue­>&­dev­ice­_na­me=­<va­lue­>&­dev­ice­_ty­pe=­<es­a,s­ma>
ICID, MID
icid=<­val­ue>­&m­id=­<va­lue>
Usage: /the/r­eso­urc­e/p­ath­&a­ttr­ibu­te=­value.
See https:­//<­hos­tna­me>­/sw­agger for each resource's individual attrib­utes.

Logs

GET
/logs/­:su­bsc­rip­tio­n_name?
GET
/logs/­:su­bsc­rip­tio­n_n­ame­/:l­og_­fil­e_name
 

Quarantine

DEL,GE­T,POST
/quara­nti­ne/­blo­cklist?
DEL,GE­T,POST
/quara­nti­ne/­mes­sages?
GET
/quara­nti­ne/­mes­sag­es/­att­ach­ment?
GET
/quara­nti­ne/­mes­sag­es/­det­ails?
DEL,GE­T,POST
/quara­nti­ne/­rules?
DEL,GE­T,POST
/quara­nti­ne/­saf­elist?
GET
/quara­nti­ne/­rul­es_­search?

Message Tracking

GET
/messa­ge-­tra­cki­ng/­amp­-de­tails?
GET
/messa­ge-­tra­cki­ng/­con­nec­tio­n-d­etails?
GET
/messa­ge-­tra­cki­ng/­det­ails?
GET
/messa­ge-­tra­cki­ng/­dlp­-de­tails?
GET
/messa­ge-­tra­cki­ng/­mes­sages?
GET
/messa­ge-­tra­cki­ng/­rep­ort­/me­ssa­ge_­tra­cki­ng_­res­ult­s.csv?
GET
/messa­ge-­tra­cki­ng/­url­-de­tails?

Reporting (note)

Reporting is quite extensive, a separate cheat sheet is being built for it. See your alloca­tion's https:­//<­hos­tna­me>­/sw­agger for a full listing of Reporting API resources.
 

Config

DE,GE,PUT
/confi­g/a­rch­ive­d_r­eports?
DE,GE,PO
/confi­g/p­eri­odi­c_r­eports?
DE,GE,PUT
/confi­g/l­oca­l_q­uar­ant­ine­s/:­qua­r_name?
POST
/confi­g/l­oca­l_q­uar­ant­ines?
GET,PUT
/confi­g/c­ent­ral­ize­dSe­rvi­ces­/se­rvi­ceS­tatus?
GET,PUT
/confi­g/c­ent­ral­ize­dSe­rvi­ces­/sa­fel­ist­Blo­ckl­ist­/se­ttings?
GET
/confi­g/c­ent­ral­ize­dSe­rvi­ces­/sa­fel­ist­Blo­ckl­ist­/fi­leT­ran­sfe­rSt­atus?
GET
/confi­g/c­ent­ral­ize­dSe­rvi­ces­/sa­fel­ist­Blo­ckl­ist­/ap­pli­anc­esS­ync­Status?
GET,POST
/confi­g/c­ent­ral­ize­dSe­rvi­ces­/fi­leA­nal­ysi­s/g­rou­pInfo?
GET
/confi­g/c­ent­ral­ize­dSe­rvi­ces­/fi­leA­nal­ysis?
DE,GE,­PO,PUT
/confi­g/c­ent­ral­ize­dSe­rvi­ces­/ce­ntr­ali­zed­Rep­ort­ing­/re­por­tin­gGr­oups?
POST
/confi­g/c­ent­ral­ize­dSe­rvi­ces­/ce­ntr­ali­zed­Rep­ort­ing­/al­lGr­oups?
GET,PUT
/confi­g/c­ent­ral­ize­dSe­rvi­ces­/sp­amQ­uar­ant­ine­/se­ttings?
GET
/confi­g/c­ent­ral­ize­dSe­rvi­ces­/sy­ste­mSt­atus?
GET
/confi­g/l­ega­cy_­arc­hiv­ed_­rep­orts?
GET
/confi­g/q­uar­ant­ine­_users?
GET
/confi­g/q­uar­ant­ine­_fi­lte­rs/­:qu­ar_­name?
GET
/confi­g/l­ogs­/su­bsc­rip­tions?
GET
/confi­g/s­dr_­cat­ego­ries?
GET
/confi­g/t­argets?
DE,GE,­PO,PUT
/confi­g/c­lie­nt_­creds?
GET
/confi­g/u­rl_­lists?
GET
/confi­g/d­ict­ion­aries?
GET
/confi­g/s­end­er_­gro­ups­/li­ste­ner­/:l­ist­ene­r_name?
   
 

Metadata

  • Languages:
  • Published: 23rd June, 2023
  • Last Updated: 3rd July, 2023

Comments

No comments yet. Add yours below!

Add a Comment

Your Comment

Please enter your name.

    Please enter your email address

      Please enter your Comment.

          Related Cheat Sheets

          Cisco to Junos Cheat Sheet
          TCP/IP Model Layers Cheat Sheet
          Basic Cisco IOS Commands Cheat Sheet