API AsyncOS 14.5 pour Cisco Secure Web Appliance – Guide de démarrage - API à usage général [Dispositif Cisco pour la sécurité sur le Web]

Résumé	`GET /wsa/api/v2.0/configure/system/smtp` `POST /wsa/api/v2.0/configure/system/smtp` `PUT /wsa/api/v2.0/configure/system/smtp` `DELETE /wsa/api/v2.0/configure/system/smtp`
Attributs de ressource pris en charge	Pour en savoir plus, consultez AsyncOS API - Addendum to the Getting Started Guide for Secure Web Appliance (API AsyncOS – Addenda au Guide de démarrage pour l'appliance Cisco pour la sécurité du Web, Secure Web Appliance).
En-têtes de requête		Hébergement, acceptation, autorisation
En-têtes de réponse		Type de contenu, longueur du contenu, connexion

Récupération des détails de l’hôte de relais SMTP

Exemple de requête

GET /wsa/api/v2.0/configure/system/smtp 
HTTP/1.1
Content-Type: application/json
Authorization: Basic YWRtaW46aXJvbnBvcnQ=
User-Agent: PostmanRuntime/7.24.1
Accept: */*
Cache-Control: no-cache
Postman-Token: 4dd1c428-a4b7-4df9-94d7-7e29e4e0dd2d
Host: 10.8.159.34:6080
Accept-Encoding: gzip, deflate, br
Connection: keep-alive

Exemple de réponse

HTTP/1.1 200 OK
Date: Tue, 12 May 2020 06:10:34 GMT
Content-type: application/json
Content-Length: 129
Connection: close
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: content-type, jwttoken, mid, h, email
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS
Access-Control-Expose-Headers: Content-Disposition, jwtToken

{"res_data": {"routing_table": "Management", "relay_hosts": []}, 
"res_message": "Data received successfully.", "res_code": "200"}

Ajout d’hôtes de relais SMTP

Exemple de requête

POST /wsa/api/v2.0/configure/system/smtp 
HTTP/1.1
Content-Type: application/json
Authorization: Basic YWRtaW46aXJvbnBvcnQ=
User-Agent: PostmanRuntime/7.24.1
Accept: */*
Cache-Control: no-cache
Postman-Token: 30ad35bc-253d-4787-8e18-4cdfa3ff3d1f
Host: 10.8.159.34:6080
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 549

{
    "routing_table": "management",
    "relay_hosts": [
        {
            "host": "191.10.55.255"
        },
        {
            "host": "10.10.55.8",
            "port": "3"
        },
        {
            "host": "google1.com",
            "port": "13"
        },
        {
            "host": "ggtalk.com",
            "port": "11"
        },
        {
            "host": "google.com",
            "port": "35"
        },
         {
            "host": "google.com",
            "port": "37"
        }
    ]
}

Exemple de réponse

HTTP/1.1 200 OK
Date: Tue, 12 May 2020 07:08:30 GMT
Content-type: application/json
Content-Length: 215
Connection: close
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: content-type, jwttoken, mid, h, email
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS
Access-Control-Expose-Headers: Content-Disposition, jwtToken

{"res_data": {"add_failure": [], "add_success": ["10.10.55.8:3", "191.10.55.255:25", 
"ggtalk.com:11", "google1.com:13", "google.com:37", "google.com:35"]}, 
"res_message": "Success:6, Failure: 0.", "res_code": "201"}

Modification des détails de l’hôte de relais SMTP

Exemple de requête

PUT /wsa/api/v2.0/configure/system/smtp 
HTTP/1.1
Content-Type: application/json
Authorization: Basic YWRtaW46aXJvbnBvcnQ=
User-Agent: PostmanRuntime/7.24.1
Accept: */*
Cache-Control: no-cache
Postman-Token: 8c18cbba-8ff3-4993-a5f3-5562fd854fde
Host: 10.8.159.34:6080
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 537

{
    "routing_table": "management",
    "relay_hosts": [
        {
            "old_host": "google.com",
            "old_port": "35",
            "new_host": "google.com",
            "new_port":"37"
        },
        {
            "old_host": "ggtalk.com",
            "old_port": "11",
            "new_host": "10.10.194.12",
            "new_port": "23"
        },
        {
            "old_host": "10.10.194.12",
            "old_port": "28",
            "new_host": "10.10.194.12",
            "new_port": "27"
        }
    ]
}

Exemple de réponse

HTTP/1.1 200 OK
Date: Tue, 12 May 2020 07:09:47 GMT
Content-type: application/json
Content-Length: 450
Connection: close
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: content-type, jwttoken, mid, h, email
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS
Access-Control-Expose-Headers: Content-Disposition, jwtToken

{"res_data": {"update_success": [{"relay_host_old": "ggtalk.com:11", 
"relay_host_new": "10.10.194.12:23"}], "update_failure": [{"relay_host_old": 
"google.com:35", "relay_host_new": "google.com:37", "err_message": 
"Given new host or port is already exist."}, {"relay_host_old": 
"10.10.194.12:28", "relay_host_new": "10.10.194.12:27", "err_message": 
"Given old host or port is not found."}]}, "res_message": "Success:1, 
Failure: 2.", "res_code": "201"}

Suppression de plusieurs hôtes de relais SMTP

Exemple de requête

DELETE /wsa/api/v2.0/configure/system/smtp 
HTTP/1.1
Content-Type: application/json
Authorization: Basic YWRtaW46aXJvbnBvcnQ=
User-Agent: PostmanRuntime/7.24.1
Accept: */*
Cache-Control: no-cache
Postman-Token: 282c385c-1804-4cd7-be25-5b62a923e175
Host: 10.8.159.34:6080
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 132

[
    {
        "host": "10.10.194.12",
        "port": "23"
    },
    {
        "host": "google.com",
        "port": "37"
    }
]

Exemple de réponse

HTTP/1.1 200 OK
Date: Tue, 12 May 2020 07:14:00 GMT
Content-type: application/json
Content-Length: 150
Connection: close
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: content-type, jwttoken, mid, h, email
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS
Access-Control-Expose-Headers: Content-Disposition, jwtToken

{"res_data": {"delete_success": ["10.10.194.12:23", "google.com:37"], 
"delete_failure": []}, "res_message": "Success:2, 
Failure:0", "res_code": "200"}

Suppression de tous les hôtes de relais SMTP

Exemple de requête

DELETE /wsa/api/v2.0/configure/system/smtp HTTP/1.1
Content-Type: application/json
Authorization: Basic YWRtaW46aXJvbnBvcnQ=
User-Agent: PostmanRuntime/7.24.1
Accept: */*
Cache-Control: no-cache
Postman-Token: c1514e19-b401-499d-9b29-47ada4f6981e
Host: 10.8.159.34:6080
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 22

{
	"delete_all":true
}

Exemple de réponse

HTTP/1.1 200 OK
Date: Tue, 12 May 2020 07:35:12 GMT
Content-type: application/json
Content-Length: 68
Connection: close
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: content-type, jwttoken, mid, h, email
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS
Access-Control-Expose-Headers: Content-Disposition, jwtToken

{"res_message": "Successfully deleted all hosts", "res_code": "200"}

Récupération des API accessibles à un rôle d’utilisateur

Vous pouvez récupérer une liste des API disponibles pour un utilisateur actuellement connecté.


Résumé	`GET /api/v2.0/login/privileges`
En-têtes de requête	Hébergement, acceptation, autorisation
En-têtes de réponse	Type de contenu, longueur du contenu, connexion

Exemple de requête

GET /wsa/api/v2.0/login/privileges HTTP/1.1
cache-control: no-cache
Postman-Token: 0cd8d318-e29b-40e0-bdc8-473f09cbd2b2
Authorization: Basic YWRtaW46aXJvbnBvcnQ=
User-Agent: PostmanRuntime/7.6.0
Accept: */*
Host: pod1224-wsa04.ibwsa.sgg.cisco.com:6080
accept-encoding: gzip, deflate
Connection: keep-alive

Exemple de réponse

HTTP/1.1 200 OK
Date: Sat, 11 Apr 2020 07:35:16 GMT
Content-type: application/json
Content-Length: 2342
Connection: close
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: content-type, jwttoken, mid, h, email
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS
Access-Control-Expose-Headers: Content-Disposition, jwtToken

{"data": ["w_preferences_preferences", "w_config_user_dashboard", "w_config_cpu_threshold", 
"w_config_memory_threshold", "config_detail", "w_reporting_web_webcat_detail", 
"w_reporting_web_ytcat_detail", "w_reporting_domains", "w_reporting_web_user_detail", 
"w_reporting_web_application_type_detail", "w_reporting_web_malware_category", 
"w_reporting_web_user_by_traffic_monitor", "w_reporting_web_amp_detail_by_filename", 
"w_reporting_web_wbrs_score_detail", "w_reporting_web_malware_name_malware_category_detail", 
"w_reporting_web_application_name_application_type_detail", "w_reporting_web_port_detail", 
"w_reporting_web_host_by_traffic_monitor", "w_reporting_web_amp_summary", 
"w_reporting_web_amp_detail_summary", "w_reporting_web_amp_file_analysis_by_filename", 
"w_reporting_web_wbrs_threat_type_detail", "w_reporting_users_by_app_type", 
"w_reporting_web_socks_destinations", "w_reporting_web_user_application_detail", 
"w_reporting_web_socks_users", "w_reporting_users_by_category", "w_reporting_web_services_summary", 
"w_reporting_web_application_type_application_name_detail", "w_reporting_web_user_webcat_detail", 
"w_reporting_web_user_amp_detail", "w_reporting_web_user_malware_name_malware_category_detail", 
"w_reporting_policy_by_user", "w_reporting_web_malware_category_malware_name_detail", 
"w_reporting_web_users_by_sha_detail", "w_reporting_web_malware_category_malware_name_user_detail", 
"w_reporting_web_filenames_by_sha", "w_reporting_web_amp_reputation_update", 
"w_reporting_users_by_app", "w_reporting_web_application_name_detail", 
"w_reporting_web_application_name_application_behavior_detail", "w_reporting_web_transaction", 
"w_reporting_web_transaction_type", "w_reporting_web_cipher_detail_client", 
"w_reporting_web_cipher_detail_server", "w_reporting_web_reporting_system", "w_percent_cpu_utilized", 
"w_percent_ram_utilized", "w_percent_disk_utilized", "w_system_uptime", "w_alerts", "w_disk_usage", 
"w_raid_status", "w_proxy_cpu_usage", "w_proxy_disk_io_util", "w_proxy_status", "w_high_availbility", 
"w_proxy_traffic_charateristics", "w_system_cpu_usage", "w_system_memory_usage", "w_bandwidth", 
"w_rps", "w_cpu_usage_by_function", "w_server_connection", "w_client_connection", "w_bandwidth_count", 
"w_rps_count", "w_decryption_count", "w_services", "w_web_tracking_web_transaction", "ctr_token", 
"ctr_client_info"]}

Récupération des fichiers de SecureX

Vous pouvez récupérer les détails de l’utilisateur enregistré.


Résumé	`GET /wsa/api/v2.0/ctr/user_info`
Attributs de ressource pris en charge	Consultez AsyncOS API - Addendum to the Getting Started Guide for Secure Web Appliance (API AsyncOS – Addenda au Guide de démarrage pour l'appliance Cisco pour la sécurité du Web, Secure Web Appliance) pour en savoir plus.
En-têtes de requête		Hébergement, acceptation, autorisation
En-têtes de réponse		Type de contenu, longueur du contenu, connexion

Exemple

Cet exemple montre une requête pour récupérer les informations de l’utilisateur enregistré.

Exemple de requête

GET/wsa/api/v2.0/ctr/user_info

HTTP/1.1

Exemple de réponse

HTTP/1.1

Response

HTTP/1.1 200 OK

Date: Thu, 25 Mar 2021 07:48:19 GMT
Content-type: application/json
Content-Length: 92
Connection: close
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: content-type, jwttoken, mid, h, email


{
    "client_id": "client-4c50a1ca-34ad-47c8-a37b-9b16153db578",
    "server": "apjc"
}

Exemple de requête pour une demande de jeton

GET/wsa/api/v2.0/ctr/token

HTTP/1.1

Exemple de réponse pour une demande de jeton

HTTP/1.1 200 OK
Date: Thu, 25 Mar 2021 07:51:19 GMT
Content-type: application/json
Content-Length: 87
Connection: close
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: content-type, jwttoken, mid, h, email
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS
Access-Control-Expose-Headers: Content-Disposition, jwtToken
{ 
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.
eyJodHRwczpcL1wvc2NoZW1hcy5jaXNjby5jb21cL2lyb2hcL2lkZW50aXR5XC9jbGFpbXNcL3VzZXJcL2VtYWls IjoiYWhhcmluYXQrYXBqY0BjaXNjby5jb20iLCJodHRwczpcL1wvc2NoZW1hcy5jaXNjby5jb21cL2lyb2hcL2lk
ZW50aXR5XC9jbGFpbXNcL3VzZXJcL3Njb3BlcyI6WyJpcm9oLWFkbWluI iwiaW50ZWdyYXRpb24iLCJwcml2YXRlLWludGVsIiwiYWRtaW4iLCJwcm9maWxlIiwiaW5zcGVjdCIsImlyb2gt
YXV0aCIsInNzZSIsInVzZXJzIiwiY2lzY28iLCJjYXNlYm9vayIsIm9yYml 0YWwiLCJlbnJpY2giLCJvYXV0aCIsImdsb2JhbC1pbnRlbCIsImNvbGxlY3QiLCJyZXNwb25zZSIsInVpLXNldH
RpbmdzIl0sImh0dHBzOlwvXC9zY2hlbWFzLmNpc2NvLmNvbVwvaXJvaFwvaWRlbnRpdHl cL2NsYWltc1wvdXNlclwvbmljayI6IkFkaGl0aHlhIEhhIiwiZW1haWwiOiJhaGFyaW5hdCthc
GpjQGNpc2NvLmNvbSIsInN1YiI6ImRiNGFiYTc0LWRiZWYtNGMxMC1iZDE4LTgzNjQ1NGJiZjU2MyIsImlzcyI6IklS T0ggQXV0aCIsImh0dHBzOlwvXC9zY2hlbWFzLmNpc2NvLmNvbVwvaXJvaFwvaWRlbnRpdHlcL2NsYWltc1wvc2NvcGVzI
jpbImVucmljaDpyZWFkIiwicmVzcG9uc2UiXSwiZXhwIjoxNTYzNzg4NjU5LCJodHRwczpcL1 hcy5jaXNjby5jb21cL2lyb2hcL2lkZW50aXR5XC9jbGFpbXNcL29hdXRoXC9jbGllbnRcL2lkIjoiY2xpZW50LTRjNTBhMWNhL
TM0YWQtNDdjOC1hMzdiLTliMTYxNTNkYjU3OCIsImh0dHBzOlwvXC9zY2hlbWFzLmNpc2NvLm NvbVwvaXJvaFwvaWRlbnRpdHlcL2NsYWltc1wvdmVyc2lvbiI6InYxLjIwLjAtOTNjMTkyOGIzMmEwZWRiNDk1ZTUiL
CJpYXQiOjE1NjM3ODgwNTksImh0dHBzOlwvXC9zY2hlbWFzLmNpc2NvLmNvbVwvaXJvaFwvaWRlbnRpd HlcL2NsYWltc1wvb2F1dGhcL2tpbmQiOiJhY2Nlc3MtdG9rZW4ifQ.SfSzvuAJbwf4gz72KPT2HEYB8D_1g8Xlk8E0O8q9Hrlre
EMl6M9nyFY3YPJueaE6J30mw258Pg8ISoG2b1mN4O5N1hnHe-0zIEmOZbYWfp9puz-0FMfQJ ysXZ1mRJkxwxWaMJ4c0rPGaPPEuw
ER2Qi6Ql8Xg9FZgp9-s5mEebeWFRbvLW9Zly1h7mjICoNF9n1y1bU8QZt0g549kIj-s047lf2qatkeoRWxinLPGtIeGl9M1s
Cvqya1sGgpGf-hFBB2KvU4JZ-c94vIYdMOHeeh7QtMIpJhy isClanrq7ke6NJlQHyi2WYifcnRnhe5BVl6MiVE89xq3CmkNBYxG5g", 
"token_type": "bearer", "expires_in": 600, "scope": "enrich:read response" 
}

Modification des paramètres de fichier de SecureX

Vous pouvez modifier les détails de l’utilisateur enregistré.


Résumé	`PUT /wsa/api/v2.0/ctr/user_info`
Attributs de ressource pris en charge	Consultez AsyncOS API - Addendum to the Getting Started Guide for Secure Web Appliance (API AsyncOS – Addenda au Guide de démarrage pour l'appliance Cisco pour la sécurité du Web, Secure Web Appliance) pour en savoir plus.
En-têtes de requête		Hébergement, acceptation, autorisation
En-têtes de réponse		Type de contenu, longueur du contenu, connexion

Exemple

Cet exemple montre comment modifier les détails de l’utilisateur enregistré pour SecureX.

Exemple de requête

PUT /wsa/api/v2.0/ctr/user_info

HTTP/1.1

Exemple de réponse

HTTP/1.1 200 OK

Date: Thu, 25 Mar 2021 07:48:19 GMT
Content-type: application/json
Content-Length: 92
Connection: close
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: content-type, jwttoken, mid, h, email
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS
Access-Control-Expose-Headers: Content-Disposition, jwtToken

{"data":{"client_id":"Y2xpZW50LWY2NzQzNjdlLTJhOTMtNDI3Yy05MGVmLWJjZmFhMGVkY2RjNA==",

"client_secret":"QmlHbGlpeFlENXNxQWVkb0R1NFprSTdzaDVGaVc5OEJMYVhEWkcydlBtWWJnR3Bud0pVZUF3",

"server":"YXBqYw=="}

}

Ajout des informations sur l’utilisateur pour SecureX

Vous pouvez ajouter les informations sur l’utilisateur pour SecureX. Cette opération vous permet de vous connecter au ruban de SecureX.


Résumé	`POST /wsa/api/v2.0/ctr/user_info`
Attributs de ressource pris en charge	Consultez AsyncOS API - Addendum to the Getting Started Guide for Secure Web Appliance (API AsyncOS – Addenda au Guide de démarrage pour l'appliance Cisco pour la sécurité du Web, Secure Web Appliance) pour en savoir plus.
En-têtes de requête		Hébergement, acceptation, autorisation
En-têtes de réponse		Type de contenu, longueur du contenu, connexion

Exemple

Cet exemple montre comment créer les informations sur l’utilisateur.

Exemple de requête

HTTP/1.1



{"data":{"client_id":"Y2xpZW50LWY2NzQzNjdlLTJhOTMtNDI3Yy05MGVmLWJjZmFhMGVkY2RjNA==",

"client_secret":"MFVTTS05cERieVh0RDF5RGE2dzZvMnlJTWtwNkZ1eFU2YnJIY1VkcW1wdzZ0M1pNMTVVWGNn",

"server":"YXBqYw=="}

}

Exemple de réponse

HTTP/1.1 200 OK

Date: Thu, 25 Mar 2021 07:32:19 GMT
Content-type: application/json
Content-Length: 32
Connection: close
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: content-type, jwttoken, mid, h, email
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS
Access-Control-Expose-Headers: Content-Disposition, jwtToken
 OK

Récupération des paramètres d’authentification

Vous pouvez récupérer les informations de base sur les configurations actuelles liées à l’authentification dans . La syntaxe et les attributs pris en charge sont les suivants :


Résumé	`GET /wsa/api/v3.0/generic_resources/auth_settings`
Attributs de ressource pris en charge	Consultez AsyncOS API - Addendum to the Getting Started Guide for Secure Web Appliance (API AsyncOS – Addenda au Guide de démarrage pour l'appliance Cisco pour la sécurité du Web, Secure Web Appliance) pour en savoir plus.
En-têtes de requête		Hébergement, acceptation, autorisation
En-têtes de réponse		Type de contenu, longueur du contenu, connexion

Exemple

Cet exemple montre une requête pour récupérer la configuration des paramètres d’authentification sur le périphérique.

Exemple de requête

GET /wsa/api/v3.0/generic_resources/auth_settings
HTTP/1.1
Host: wsa.example.com:6443
User-Agent: curl/7.55.1
Accept: */*
Authorization: Basic YWRtaW46Q2lzY28xMjMk

Exemple de réponse

HTTP/1.1 200 OK
Date: Mon, 11 Jan 2021 08:22:28 GMT
Content-type: application/json
Content-Length: 1339
Connection: close
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: content-type, jwttoken, mid, h, email
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: Content-Disposition, jwtToken

{
    "header_based_auth": "disable",
    "realms": [
        {
            "schemes": [
                "Basic"
            ],
            "type": "LDAP",
            "name": "AuthLDAP",
            "supportes_tui": false
        },
        {
            "schemes": [
                "Basic"
            ],
            "type": "LDAP",
            "name": "AuthLDAPTUI",
            "supportes_tui": true
        },
        {
            "schemes": [
                "Kerberos",
                "NTLMSSP",
                "Basic",
                "Header"
            ],
            "type": "AD",
            "name": "AuthADTUI",
            "supportes_tui": true
        },
        {
            "schemes": [
                "Kerberos",
                "NTLMSSP",
                "Basic",
                "Header"
            ],
            "type": "AD",
            "name": "AuthAD",
            "supportes_tui": false
        }
    ],
    "sequences": [
        {
            "schemes": [
                "NTLMSSP",
                "Basic",
                "Header",
                "Kerberos"
            ],
            "name": "All Realms"
        },
        {
            "schemes": [
                "Basic",
                "Header",
                "Kerberos"
            ],
            "name": "myAuthSequence"
        }
    ]
}

Récupération des agents utilisateurs

Vous pouvez récupérer tous les agents utilisateurs autorisés reconnus par . La syntaxe et les attributs pris en charge sont les suivants :


Résumé	`GET /wsa/api/v3.0/generic_resources/user_agents`
Attributs de ressource pris en charge	Consultez AsyncOS API - Addendum to the Getting Started Guide for Secure Web Appliance (API AsyncOS – Addenda au Guide de démarrage pour l'appliance Cisco pour la sécurité du Web, Secure Web Appliance) pour en savoir plus.
En-têtes de requête		Hébergement, acceptation, autorisation
En-têtes de réponse		Type de contenu, longueur du contenu, connexion

Exemple

Cet exemple montre une requête pour récupérer tous les agents utilisateurs reconnus par le périphérique.

Exemple de requête

GET /wsa/api/v3.0/generic_resources/user_agents
HTTP/1.1
Host: wsa.example.com:6443
User-Agent: curl/7.55.1
Accept: */*
Authorization: Basic YWRtaW46Q2lzY28xMjMk

Exemple de réponse

HTTP/1.1 200 OK
Date: Mon, 11 Jan 2021 08:22:28 GMT
Content-type: application/json
Content-Length: 616
Connection: close
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: content-type, jwttoken, mid, h, email
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: Content-Disposition, jwtToken

{
    "user_agents": [
        "Chrome/48",
        "windows_updater",
        "Firefox/40",
        "Firefox/41",
        "Firefox/42",
        "Firefox/43",
        "Chrome/45",
        "Chrome/46",
        "Chrome/47",
        "Chrome",
        "Safari",
        "adobe_updater",
        "MSIE",
        "Safari/5",
        "Safari/4",
        "Safari/7",
        "Safari/6",
        "Opera",
        "Safari/9",
        "Safari/8",
        "MSIE/11",
        "MSIE/10",
        "Firefox",
        "MSIE/9",
        "MSIE/8",
        "Opera/33",
        "Opera/32",
        "Opera/35",
        "Opera/34"
    ]
}

Récupération de catégories d’URL

Vous pouvez récupérer toutes les catégories d’URL autorisées qui sont définies par . Cette API contient également des catégories définies par l’utilisateur. La syntaxe et les attributs pris en charge sont les suivants :


Résumé	`GET /wsa/api/v3.0/generic_resources/url_categories`
Attributs de ressource pris en charge	Pour en savoir plus, consultez AsyncOS API - Addendum to the Getting Started Guide for Secure Web Appliance (API AsyncOS – Addenda au Guide de démarrage pour l'appliance Cisco pour la sécurité du Web, Secure Web Appliance).
En-têtes de requête		Hébergement, acceptation, autorisation
En-têtes de réponse		Type de contenu, longueur du contenu, connexion

Exemple

Cet exemple montre une requête pour récupérer toutes les catégories d’URL (prédéfinies et personnalisées) configurées sur le périphérique.

Exemple de requête

GET /wsa/api/v3.0/generic_resources/url_categories
HTTP/1.1
Host: wsa.example.com:6443
User-Agent: curl/7.55.1
Accept: */*
Authorization: Basic YWRtaW46Q2lzY28xMjMk

Exemple de réponse

HTTP/1.1 200 OK
Date: Mon, 11 Jan 2021 08:22:28 GMT
Content-type: application/json
Content-Length: 2316
Connection: close
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: content-type, jwttoken, mid, h, email
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: Content-Disposition, jwtToken

{
    "predefined": [
        "Adult",
        "Advertisements",
        "Alcohol",
        "Arts",
        "Astrology",
        "Auctions",
        "Business and Industry",
        "Chat and Instant Messaging",
        "Cheating and Plagiarism",
        "Child Abuse Content",
        "Computer Security",
        "Computers and Internet",
        "DIY Projects",
        "Dating",
        "Digital Postcards",
        "Dining and Drinking",
        "Dynamic and Residential",
        "Education",
        "Entertainment",
        "Extreme",
        "Fashion",
        "File Transfer Services",
        "Filter Avoidance",
        "Finance",
        "Freeware and Shareware",
        "Gambling",
        "Games",
        "Government and Law",
        "Hacking",
        "Hate Speech",
        "Health and Nutrition",
        "Humor",
        "Hunting",
        "Illegal Activities",
        "Illegal Downloads",
        "Illegal Drugs",
        "Infrastructure and Content Delivery Networks",
        "Internet Telephony",
        "Job Search",
        "Lingerie and Swimsuits",
        "Lotteries",
        "Military",
        "Mobile Phones",
        "Nature",
        "News",
        "Non-governmental Organizations",
        "Non-sexual Nudity",
        "Online Communities",
        "Online Meetings",
        "Online Storage and Backup",
        "Online Trading",
        "Organizational Email",
        "Paranormal",
        "Parked Domains",
        "Peer File Transfer",
        "Personal Sites",
        "Personal VPN",
        "Photo Search and Images",
        "Politics",
        "Pornography",
        "Professional Networking",
        "Real Estate",
        "Reference",
        "Religion",
        "SaaS and B2B",
        "Safe for Kids",
        "Science and Technology",
        "Search Engines and Portals",
        "Sex Education",
        "Shopping",
        "Social Networking",
        "Social Science",
        "Society and Culture",
        "Software Updates",
        "Sports and Recreation",
        "Streaming Audio",
        "Streaming Video",
        "Tobacco",
        "Transportation",
        "Travel",
        "Weapons",
        "Web Hosting",
        "Web Page Translation",
        "Web-based Email"
    ],
    "custom": [
        "mycategory",
        "mycategoryo365"
    ]
}

Récupération de plages de temps

Vous pouvez récupérer la liste des plages de temps configurées dans Secure Web Appliance. La syntaxe et les attributs pris en charge sont les suivants :


Résumé	`GET /wsa/api/v3.0/web_security/time_ranges`
Attributs de ressource pris en charge	Consultez AsyncOS API - Addendum to the Getting Started Guide for Secure Web Appliance (API AsyncOS – Addenda au Guide de démarrage pour l'appliance Cisco pour la sécurité du Web, Secure Web Appliance) pour en savoir plus.
En-têtes de requête		Hébergement, acceptation, autorisation
En-têtes de réponse		Type de contenu, longueur du contenu, connexion

Exemple

Cet exemple montre une requête pour récupérer les plages de temps configurées sur le périphérique.

Exemple de requête

GET /wsa/api/v3.0/web_security/time_ranges
HTTP/1.1
Host: wsa.example.com:6443
User-Agent: curl/7.55.1
Accept: */*
Authorization: Basic YWRtaW46Q2lzY28xMjMk

Exemple de réponse

HTTP/1.1 200 OK
Date: Mon, 11 Jan 2021 08:22:28 GMT
Content-type: application/json
Content-Length: 971
Connection: close
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: content-type, jwttoken, mid, h, email
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: Content-Disposition, jwtToken

{
    "time_ranges": [
        {
            "time_values": [
                {
                    "time_of_day": "all_day",
                    "valid_days": [
                        "Saturday",
                        "Friday",
                        "Thursday",
                        "Monday",
                        "Tuesday",
                        "Wednesday"
                    ]
                }
            ],
            "name": "TestTimeRange",
            "time_zone": "America/Los_Angeles"
        },
        {
            "time_values": [
                {
                    "time_of_day": {
                        "to": "18:00",
                        "from": "10:00"
                    },
                    "valid_days": [
                        "Monday",
                        "Sunday"
                    ]
                }
            ],
            "name": "mytimerange",
            "time_zone": "Asia/Shanghai"
        }
    ]
}

Récupération des quotas

Vous pouvez récupérer la liste des quotas configurés dans Secure Web Appliance. La syntaxe et les attributs pris en charge sont les suivants :


Résumé	`GET /wsa/api/v3.0/web_security/quotas`
Attributs de ressource pris en charge	Pour en savoir plus, consultez AsyncOS API - Addendum to the Getting Started Guide for Secure Web Appliance (API AsyncOS – Addenda au Guide de démarrage pour l'appliance Cisco pour la sécurité du Web, Secure Web Appliance).
En-têtes de requête		Hébergement, acceptation, autorisation
En-têtes de réponse		Type de contenu, longueur du contenu, connexion

Exemple

Cet exemple montre une requête pour récupérer les quotas configurés sur le périphérique.

Exemple de requête

GET /wsa/api/v3.0/web_security/quotas
HTTP/1.1
Host: wsa.example.com:6443
User-Agent: curl/7.55.1
Accept: */*
Authorization: Basic YWRtaW46Q2lzY28xMjMk

Exemple de réponse

HTTP/1.1 200 OK
Date: Mon, 11 Jan 2021 08:22:28 GMT
Content-type: application/json
Content-Length: 607
Connection: close
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: content-type, jwttoken, mid, h, email
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: Content-Disposition, jwtToken

{
    "quotas": [
        {
            "reset_time": "0:00",
            "volume_quota": 1073741824,
            "time_quota_secs": 0,
            "name": "myquota2",
            "time_zone": "America/Los_Angeles"
        },
        {
            "volume_quota": 0,
            "time_quota_secs": 54000,
            "name": "myquota",
            "time_range": "mytimerange"
        },
        {
            "reset_time": "0:00",
            "volume_quota": 60129542144,
            "time_quota_secs": 58560,
            "name": "myquota3",
            "time_zone": "America/Los_Angeles"
        }
    ]
}

Récupération des paramètres du proxy

Vous pouvez récupérer les configurations liées au proxy (proxy Web, proxy Socks, etc.) dans . La réponse indique si un type particulier de proxy est activé ou non. Elle fournit également des informations sur le mode du proxy, comme les modes transparent ou de transmission (applicable uniquement au proxy Web). La syntaxe et les attributs pris en charge sont les suivants :


Résumé	`GET /wsa/api/v3.0/generic_resources/proxy_settings`
Attributs de ressource pris en charge	Consultez AsyncOS API - Addendum to the Getting Started Guide for Secure Web Appliance (API AsyncOS – Addenda au Guide de démarrage pour l'appliance Cisco pour la sécurité du Web, Secure Web Appliance) pour en savoir plus.
En-têtes de requête		Hébergement, acceptation, autorisation
En-têtes de réponse		Type de contenu, longueur du contenu, connexion

Exemple

Cet exemple montre une requête pour récupérer les configurations liées au proxy (proxy Web, proxy Socks, etc.) sur le périphérique.

Exemple de requête

GET /wsa/api/v3.0/generic_resources/proxy_settings
HTTP/1.1
Host: wsa.example.com:6443
User-Agent: curl/7.55.1
Accept: */*
Authorization: Basic YWRtaW46Q2lzY28xMjMk

Exemple de réponse

HTTP/1.1 200 OK
Date: Mon, 11 Jan 2021 08:22:28 GMT
Content-type: application/json
Content-Length: 207
Connection: close
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: content-type, jwttoken, mid, h, email
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: Content-Disposition, jwtToken

{
    "proxy_settings": {
        "web": {
            "status": "enable",
            "mode": "transparent"
        },
        "socks": "disable",
        "https": "enable",
        "ftp": "enable"
    }
}

Récupération des méthodes d’identification

Vous pouvez récupérer des informations sur les méthodes d’identification autorisées et non autorisées qui peuvent être utilisées lors de la création de profils d’identification. La syntaxe et les attributs pris en charge sont les suivants :


Résumé	`GET /wsa/api/v3.0/generic_resources/identification_methods`
Attributs de ressource pris en charge	Consultez AsyncOS API - Addendum to the Getting Started Guide for Secure Web Appliance (API AsyncOS – Addenda au Guide de démarrage pour l'appliance Cisco pour la sécurité du Web, Secure Web Appliance) pour en savoir plus.
En-têtes de requête		Hébergement, acceptation, autorisation
En-têtes de réponse		Type de contenu, longueur du contenu, connexion

Exemple

Cet exemple montre une requête pour obtenir les méthodes d’identification configurées sur le périphérique.

Exemple de requête

GET /wsa/api/v3.0/generic_resources/identification_methods
HTTP/1.1
Host: wsa.example.com:6443
User-Agent: curl/7.55.1
Accept: */*
Authorization: Basic YWRtaW46Q2lzY28xMjMk

Exemple de réponse

HTTP/1.1 200 OK
Date: Mon, 11 Jan 2021 08:22:28 GMT
Content-type: application/json
Content-Length: 154
Connection: close
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: content-type, jwttoken, mid, h, email
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: Content-Disposition, jwtToken

{
    "identification_methods": {
        "tui": "disable",
        "authentication": "enable",
        "asa": "enable",
        "ise": "disable"
    }
}

API AsyncOS 14.5 pour Cisco Secure Web Appliance – Guide de démarrage

Langage exempt de préjugés

À propos de la traduction

Book Title

API AsyncOS 14.5 pour Cisco Secure Web Appliance – Guide de démarrage

Chapter Title

API à usage général

Results

Chapter: API à usage général

API à usage général

Récupération des détails de l’hôte de relais SMTP

Ajout d’hôtes de relais SMTP

Modification des détails de l’hôte de relais SMTP

Suppression de plusieurs hôtes de relais SMTP

Suppression de tous les hôtes de relais SMTP

Récupération des API accessibles à un rôle d’utilisateur

Récupération des fichiers de SecureX

Exemple

Modification des paramètres de fichier de SecureX

Exemple

Ajout des informations sur l’utilisateur pour SecureX

Exemple

Récupération des paramètres d’authentification

Exemple

Récupération des agents utilisateurs

Exemple

Récupération de catégories d’URL

Exemple

Récupération de plages de temps

Exemple

Récupération des quotas

Exemple

Récupération des paramètres du proxy

Exemple

Récupération des méthodes d’identification

Exemple

Ce document vous est-il utile?

Contacter Cisco