MS Exchange Server

POST/api/2.0/fo/auth/ms_exchange/

Create, update, list and delete MS Exchange Server authentication records. Compliance scans are supported (using PC).

Input ParametersInput Parameters

Parameter	Required/Optional	Data Type	Description
action={action}	Required	String	Specify create, update, delete (using POST) or list (using GET or POST).
echo_request={0\|1}	Optional	Integer	Specify 1 to view (echo) input parameters in the XML output. By default these are not included.
ids={value}	Required to update or delete record	Integer	Record IDs to update/delete. Specify record IDs and/or ID ranges (for example, 1359-1407). Multiple entries are comma separated.
title={value}	Required to create record	String	A title for the record. The title must be unique. Maximum 255 characters (ascii).
comments={value}	Optional to create or update record	String	User defined comments. Maximum of 1999 characters.
Target Hosts
ips={value}	Required to create record Optional to update record	Integer	The IP address(es) the server will log into using the record’s credentials. Multiple entries are comma separated. IPs specified will overwrite existing IPs in the record, and existing IPs will be removed.
add_ips={value}	Optional to update record	Integer	Add IPs to the IPs list for this record. Multiple IPs/ranges are comma separated.
remove_ips={value}	Optional to update record	Integer	IPs to be removed from your record. You may enter a combination of IPs and ranges. Multiple entries are comma separated. This parameter and the ips parameter cannot be specified in the same request.
network_id={value}	Optional and valid when the networks feature is enabled	Integer	The network ID for the record.

Sample - List MS Exchange Server recordsSample - List MS Exchange Server records

API request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl" -d
"action=list&details=Basic"
"https://<qualys_base_url>/api/2.0/fo/auth/ms_exchange/"

XML output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE AUTH_MS_EXCHANGE_LIST_OUTPUT SYSTEM
"https://<qualys base url>/api/2.0/fo/auth/ms_exchange/auth_ms_
exchange_list_output.dtd">
<AUTH_MS_EXCHANGE_LIST_OUTPUT>
    <RESPONSE>
        <DATETIME>2019-03-20T07:26:38Z</DATETIME>
        <AUTH_MS_EXCHANGE_LIST>
            <AUTH_MS_EXCHANGE>
                <ID>48050</ID>
                <TITLE>
                    <![CDATA[msexchange01]]>
                </TITLE>
                <IP_SET>
                    <IP>10.10.10.10</IP>
                </IP_SET>
                <NETWORK_ID>0</NETWORK_ID>
                <CREATED>
                    <DATETIME>2019-03-14T07:05:05Z</DATETIME>
                    <BY>quays_sp1</BY>
                </CREATED>
                <LAST_MODIFIED>
                    <DATETIME>2019-03-14T07:05:05Z</DATETIME>
                </LAST_MODIFIED>
                <COMMENTS>
                    <![CDATA[msexchange]]>
                </COMMENTS>
            </AUTH_MS_EXCHANGE>
...

            <AUTH_MS_EXCHANGE>
                <ID>49026</ID>
                <TITLE>
                    <![CDATA[apicreate]]>
                </TITLE>
                <IP_SET>
                    <IP>10.10.10.13</IP>
                </IP_SET>
                <NETWORK_ID>0</NETWORK_ID>
                <CREATED>
                    <DATETIME>2019-03-19T11:46:23Z</DATETIME>
                    <BY>quays_sp1</BY>
                </CREATED>
                <LAST_MODIFIED>
                    <DATETIME>2019-03-19T11:56:57Z</DATETIME>
                </LAST_MODIFIED>
                <COMMENTS>
                    <![CDATA[editapicomment]]>
                </COMMENTS>
            </AUTH_MS_EXCHANGE>
        </AUTH_MS_EXCHANGE_LIST>
    </RESPONSE>
</AUTH_MS_EXCHANGE_LIST_OUTPUT>

Sample - Update MS Exchange Server recordSample - Update MS Exchange Server record

API request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: curl sample" -d
"action=update&ids=49029&title=forupdate&comments=editwapicomment&
ips=10.10.10.11"
"https://<qualys base url>/api/2.0/fo/auth/ms_exchange/"

XML output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM
"https://<qualys base url>/api/2.0/batch_return.dtd">
<BATCH_RETURN>
    <RESPONSE>
        <DATETIME>2019-03-20T08:29:48Z</DATETIME>
        <BATCH_LIST>
            <BATCH>
                <TEXT>Successfully Updated</TEXT>
                <ID_SET>
                    <ID>49029</ID>
                </ID_SET>
            </BATCH>
        </BATCH_LIST>
    </RESPONSE>
</BATCH_RETURN>

Sample - Delete MS Exchange Server record (single)Sample - Delete MS Exchange Server record (single)

API request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: curl sample" -d
"action=delete&ids=49026"
"https://<qualys base url>/api/2.0/fo/auth/ms_exchange/"

XML output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM
"https://<qualys base url>/api/2.0/batch_return.dtd">
<BATCH_RETURN>
    <RESPONSE>
        <DATETIME>2019-03-20T07:56:00Z</DATETIME>
        <BATCH_LIST>
            <BATCH>
                <TEXT>Successfully Deleted</TEXT>
                <ID_SET>
                    <ID>49026</ID>
                </ID_SET>
            </BATCH>
        </BATCH_LIST>
    </RESPONSE>
</BATCH_RETURN>

Sample - Delete MS Exchange Server records (bulk)Sample - Delete MS Exchange Server records (bulk)

API request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: curl sample" -d
"action=delete&ids=49028,49029"
"https://<qualys base url>/api/2.0/fo/auth/ms_exchange/"

XML output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM
"https://<qualys base url>/api/2.0/batch_return.dtd">
<BATCH_RETURN>
    <RESPONSE>
        <DATETIME>2019-03-20T08:31:35Z</DATETIME>
        <BATCH_LIST>
            <BATCH>
                <TEXT>Successfully Deleted</TEXT>
                <ID_SET>
                    <ID_RANGE>49028-49029</ID_RANGE>
                </ID_SET>
            </BATCH>
        </BATCH_LIST>
    </RESPONSE>
</BATCH_RETURN>

DTDs for auth type “ms_exchange”

<platform API server>/api/2.0/batch_return.dtd

<platform API server>/api/2.0/fo/auth/ms_exchange/auth_ms_exchange_list_output.dtd