MarkLogic Record

POST /api/2.0/fo/auth/marklogic

Create, update, list, and delete MarkLogic records for authenticated scans of MarkLogic instances. Compliance scans are supported (using PC).

Input ParametersInput Parameters

Parameter	Required/Optional	Data Type	Description
action={action}	Required	String	Specify any one of the following: create, update, list, delete.
title={value}	Required to create and update a record	String	A title for the record.
ips={value}	Required	Integer	IPs to be added to your MarkLogic record. You may enter a combination of IPs and IP ranges to identify compliance hosts. Multiple entries are comma separated.
ids={value}	Required	Integer	MarkLogic Record IDs to edit and delete. Specify record IDs and/or ID ranges. Multiple entries are comma separated.
username={value}	Required	String	The username to be used for authentication to Marklogic.
password={value}	Required	String	The password to be used for authentication to MarkLogic.
port={value}	Required	Integer	The port number that the MarkLogic database instance is running on.
ssl_verify_with_host={0\|1}	Optional	Boolean	SSL verification. Set to 1 if you want to verify the server’s certificate is valid and trusted.
hosts={value}	Required if ssl_verify_with_host=1	String	A list of FQDNs for all host IP addresses on which a custom SSL certificate signed by a trusted root CA is installed.
require_cert={0\|1}	Optional	Boolean	Set this to 1 when you want to authenticate the MarkLogic instance via certificate and private_key. Enabling this from API switch on the Require Certificate toggle on UI.
certificate={value}	Required if require_cert is set to 1.	String	Certificate content
private_key={value}	Required if require_cert is set to 1.	String	private_key details
unix_installation_path={value}	Optional	String	Unix installation path to MarkLogic.
unix_conf_path={value}	Optional	String	Unix configuration path to MarkLogic.
window_installation_path={value}	Optional	String	Windows installation path to MarkLogic
window_conf_path={value}	Optional	String	Windows configuration path to MarkLogic.
admin_port={value}	Optional	Integer	Administrator configuration path to MarkLogic
admin_ssl_verify_with_host ={value}	Required if ssl_verify_with_host=1	Boolean	SSL verification is for admin server. Set to 1 if you want to verify the server’s certificate is valid and trusted.
admin_hosts={value}	Required if admin_ssl_verify_with_host=1)	String	A list of FQDNs for all admin server host IP addresses on which a custom SSL certificate signed by a trusted root CA is installed.

Sample Create RecordSample Create Record

API Request

curl -s -S -H 'X-Requested-With:curl demo2' -u "Username:Password" -d
"action=create&title=marklogic_api1&username=test&password=abc&port=78&ip
s=1.1.1.1&ssl_verify_with_host=1&hosts=abc.com&require_cert=1&certificate
=-----BEGIN CERTIFICATE-----
MIID0DCCArigAwIBAgIBATANBgkqhkiG9w0BAQUFADB/MQswCQYDVQQGEwJGUjETMBEGA1UECAwKU29tZS1TdGF0ZTEOMAwGA1UEBwwFUGFyaXMxDTALBgNVBAoMBERpbWkxDTALBgNVBAsMBE5TQlUxEDAOBgNVBAMMB0RpbWkgQ0ExGzAZBgkqhkiG9w0BCQEWDGRpbWlAZGltaS5mcjAeFw0xNDAxMjgyMDM2NTVaFw0yNDAxMjYyMDM2NTVaMFsxCzAJBgNVBAYTAkZSMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQxFDASBgNVBAMMC3d3dy5kaW1pLmZyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvpnaPKLIKdvx98KW68lz8pGaRRcYersNGqPjpifMVjjE8LuCoXgPU0HePnNTUjpShBnynKCvrtWhN+haKbSp+QWXSxiTrW99HBfAl1MDQyWcukoEb9Cw6INctVUN4iRvkn9T8E6q174RbcnwA/7yTc7p1NCvw+6B/aAN9l1G2pQXgRdYC/+G6o1IZEHtWhqzE97nY5QKNuUVD0V09dc5CDYBaKjqetwwv6DFk/GRdOSEd/6bW+20z0qSHpa3YNW6qSp+x5pyYmDrzRIR03os6DauZkChSRyc/Whvurx6o85D6qpzywo8xwNaLZHxTQPgcIA5su9ZIytv9LH2E+lSwwIDAQABo3sweTAJBgNVHRMEAjAAMCwGCWCGSAGG+EIBDQQfFh1PcGVuU1NMIEdlbmVyYXRlZCBDZXJ0aWZpY2F0ZTAdBgNVHQ4EFgQU+tugFtyN+cXe1wxUqeA7X+yS3bgwHwYDVR0jBBgwFoAUhMwqkbBrGp87HxfvwgPnlGgVR64wDQYJKoZIhvcNAQEFBQADggEBAIEEmqqhEzeXZ4CKhE5UM9vCKzkj5Iv9TFs/a9CcQuepzplt7YVmevBFNOc0+1ZyR4tXgi4+5MHGzhYCIVvHo4hKqYm+J+o5mwQInf1qoAHuO7CLD3WNa1sKcVUVvepIxc/1aHZrG+dPeEHt0MdFfOw13YdUc2FH6AqEdcEL4aV5PXq2eYR8hR4zKbc1fBtuqUsvA8NWSIyzQ16fyGve+ANf6vXvUizyvwDrPRv/kfvLNa3ZPnLMMxU98MvhPXy3PkB8++6U4Y3vdk2Ni2WYYlIls8yqbM4327IKmkDc2TimS8u60CT47mKU7aDYcbTV5RDkrlaYwm5yqlTIglvCv7o=-----
END CERTIFICATE-----&private_key=-----BEGIN RSA PRIVATE KEY-----
MIIEowIBAAKCAQEAvpnaPKLIKdvx98KW68lz8pGaRRcYersNGqPjpifMVjjE8LuCoXgPU0HePnNTUjpShBnynKCvrtWhN+haKbSp+QWXSxiTrW99HBfAl1MDQyWcukoEb9Cw6INctVUN4iRvkn9T8E6q174RbcnwA/7yTc7p1NCvw+6B/aAN9l1G2pQXgRdYC/+G6o1IZEHtWhqzE97nY5QKNuUVD0V09dc5CDYBaKjqetwwv6DFk/GRdOSEd/6bW+20z0qSHpa3YNW6qSp+x5pyYmDrzRIR03os6DauZkChSRyc/Whvurx6o85D6qpzywo8xwNaLZHxTQPgcIA5su9ZIytv9LH2E+lSwwIDAQABAoIBAFml8cD9a5pMqlW3f9btTQz1sRL4Fvp7CmHSXhvjsjeHwhHckEe0ObkWTRsgkTsm1XLu5W8IITnhn0+1iNr+78eB+rRGngdAXh8diOdkEy+8/Cee8tFI3jyutKdRlxMbwiKsouVviumoq3fxOGQYwQ0Z2l/PvCwy/Y82ffq3ysC5gAJsbBYsCrg14bQo44ulrELe4SDWs5HCjKYbEI2b8cOMucqZSOtxg9niLN/je2bo/I2HGSawibgcOdBms8k6TvsSrZMr3kJ5O6J+77LGwKH37brVgbVYvbq6nWPL0xLG7dUv+7LWEo5qQaPy6aXb/zbckqLqu6/EjOVeydG5JQECgYEA9kKfTZD/WEVAreA0dzfeJRu8vlnwoagL7cJaoDxqXos4mcr5mPDTkbWgFkLFFH/AyUnPBlK6BcJp1XK67B13ETUa3i9Q5t1WuZEobiKKBLFm9DDQJt43uKZWJxBKFGSvFrYPtGZst719mZVcPct2CzPjEgN3Hlpt6fyw3eOrnoECgYEAxiOujwXCOmuGaB7+OW2tR0PGEzbvVlEGdkAJ6TC/HoKM1A8r2u4hLTEJJCrLLTfw++4IddHE2dLeR4Q7O58SfLphwgPmLDezN7WRLGr7Vyfuv7VmaHjGuC3Gv9agnhWDlA2QgBG9/R9oVfL0Dc7CgJgLeUtItCYC31bGT3yhV0MCgYEA4k3DG4L+RN4PXDpHvK9IpA1jXAJHEifeHnaW1d3vWkbSkvJmgVf+9U5VeV+OwRHN1qzPZV4suRI6M/8lK8rAGr4UnM4aqK4K/qkY4G05LKrik9Ev2CgqSLQDRA7CJQ+Jn3Nb50qg6hFnFPafN+J77juWln08wFYV4Atpdd+9XQECgYBxizkZFL+9IqkfOcONvWAzGo+Dq1N0L3J4iTIkw56CKWXyj88d4qB4eUU3yJ4uB4S9miaW/eLEwKZIbWpUPFAn0db7i6h3ZmP5ZL8QqS3nQCb9DULmU2/tU641eRUKAmIoka1g9sndKAZuWo+o6fdkIb1RgObk9XNn8R4rpsv+aQKBgB+CIcExR30vycv5bnZN9EFlIXNKaeMJUrYCXcRQNvrnUIUBvAO8+jAeCdLygS5RtgOLZib0IVErqWsP3EI1ACGuLts0vQ9GFLQGaN1SaMS40C9kvns1m
lDuLhIhYpJ8UsCVt5snWo2N+M+6ANh5tpWdQnEK6zILh4tRbuzaiHgb-----END RSA
PRIVATE KEY-----&"
"https://<qualys_base_url>/api/2.0/fo/auth/marklogic/"

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>2024-06-04T05:20:20Z</DATETIME>
      <BATCH_LIST>
         <BATCH>
            <TEXT>Successfully Created</TEXT>
            <ID_SET>
               <ID>4706058</ID>
            </ID_SET>
         </BATCH>
      </BATCH_LIST>
   </RESPONSE>
</BATCH_RETURN>

Sample Update RecordSample Update Record

API Request

curl -s -S -H 'X-Requested-With:curl demo2' -u "Username:Password" -d
"action=update&ids=4706058&port=99"
"https://<qualys_base_url>/api/2.0/fo/auth/marklogic/"

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>2024-06-04T09:13:18Z</DATETIME>
      <BATCH_LIST>
         <BATCH>
            <TEXT>Successfully Updated</TEXT>
            <ID_SET>
               <ID>4706058</ID>
            </ID_SET>
         </BATCH>
      </BATCH_LIST>
   </RESPONSE>
</BATCH_RETURN>

Sample Delete RecordSample Delete Record

API Request

curl -s -S -H 'X-Requested-With:curl demo2' -u "Username:Password" -d
"action=delete&ids=4706058"
"https://<qualys_base_url>/api/2.0/fo/auth/marklogic/"

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>2024-06-04T09:13:55Z</DATETIME>
      <BATCH_LIST>
         <BATCH>
            <TEXT>Successfully Deleted</TEXT>
            <ID_SET>
               <ID>4706058</ID>
            </ID_SET>
         </BATCH>
      </BATCH_LIST>
   </RESPONSE>
</BATCH_RETURN>

Sample List RecordSample List Record

API Request

curl -s -S -H 'X-Requested-With:curl demo2' -u "Username:Password" -d "action=list&ids=5106487" 
"https://<qualys_base_url>/api/2.0/fo/auth/marklogic/"

XML Output

 <?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE AUTH_MARKLOGIC_LIST_OUTPUT SYSTEM 
https://<qualys_base_url>/api/2.0/fo/auth/marklogic/auth_marklogic_list_output.dtd>
<AUTH_MARKLOGIC_LIST_OUTPUT>
    <RESPONSE>
        <DATETIME>2024-07-02T08:06:10Z</DATETIME>
        <AUTH_MARKLOGIC_LIST>
            <AUTH_MARKLOGIC>
                <ID>5106487</ID>
                <TITLE>
                    <![CDATA[marklogic ]]>
                </TITLE>
                <USERNAME>
                    <![CDATA[test]]>
                </USERNAME>
                <IP_SET>
                    <IP>1.1.1.1</IP>
                </IP_SET>
                <REQUIRE_CERT>
                    <![CDATA[1]]>
                </REQUIRE_CERT>
                <PORT>
                    <![CDATA[8001]]>
                </PORT>
                <SSL_VERIFY_WITH_HOST>
                    <![CDATA[1]]>
                </SSL_VERIFY_WITH_HOST>
                <HOSTS>
                    <![CDATA[abc.com]]>
                </HOSTS>
                <CERTIFICATE>
                    <![CDATA[-----BEGIN CERTIFICATE-----MIID0DCCArigAwIBAgIBATANBgkqhkiG9w0BAQUFADB/MQswCQYDVQQGEwJGUjETMBEGA1UECAwKU29tZS1TdGF0ZTEOMAwGA1UEBwwFUGFyaXMxDTALBgNVBAoMBERpbWkxDTALBgNVBAsMBE5TQlUxEDAOBgNVBAMMB0RpbWkgQ0ExGzAZBgkqhkiG9w0BCQEWDGRpbWlAZGltaS5mcjAeFw0xNDAxMjgyMDM2NTVaFw0yNDAxMjYyMDM2NTVaMFsxCzAJBgNVBAYTAkZSMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQxFDASBgNVBAMMC3d3dy5kaW1pLmZyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvpnaPKLIKdvx98KW68lz8pGaRRcYersNGqPjpifMVjjE8LuCoXgPU0HePnNTUjpShBnynKCvrtWhN+haKbSp+QWXSxiTrW99HBfAl1MDQyWcukoEb9Cw6INctVUN4iRvkn9T8E6q174RbcnwA/7yTc7p1NCvw+6B/aAN9l1G2pQXgRdYC/+G6o1IZEHtWhqzE97nY5QKNuUVD0V09dc5CDYBaKjqetwwv6DFk/GRdOSEd/6bW+20z0qSHpa3YNW6qSp+x5pyYmDrzRIR03os6DauZkChSRyc/Whvurx6o85D6qpzywo8xwNaLZHxTQPgcIA5su9ZIytv9LH2E+lSwwIDAQABo3sweTAJBgNVHRMEAjAAMCwGCWCGSAGG+EIBDQQfFh1PcGVuU1NMIEdlbmVyYXRlZCBDZXJ0aWZpY2F0ZTAdBgNVHQ4EFgQU+tugFtyN+cXe1wxUqeA7X+yS3bgwHwYDVR0jBBgwFoAUhMwqkbBrGp87HxfvwgPnlGgVR64wDQYJKoZIhvcNAQEFBQADggEBAIEEmqqhEzeXZ4CKhE5UM9vCKzkj5Iv9TFs/a9CcQuepzplt7YVmevBFNOc0+1ZyR4tXgi4+5MHGzhYCIVvHo4hKqYm+J+o5mwQInf1qoAHuO7CLD3WNa1sKcVUVvepIxc/1aHZrG+dPeEHt0MdFfOw13YdUc2FH6AqEdcEL4aV5PXq2eYR8hR4zKbc1fBtuqUsvA8NWSIyzQ16fyGve+ANf6vXvUizyvwDrPRv/kfvLNa3ZPnLMMxU98MvhPXy3PkB8++6U4Y3vdk2Ni2WYYlIls8yqbM4327IKmkDc2TimS8u60CT47mKU7aDYcbTV5RDkrlaYwm5yqlTIglvCv7o=-----END CERTIFICATE-----]]>
                </CERTIFICATE>
                <PRIVATE_KEY>
                    <![CDATA[-----BEGIN RSA PRIVATE KEY-----MIIEowIBAAKCAQEAvpnaPKLIKdvx98KW68lz8pGaRRcYersNGqPjpifMVjjE8LuCoXgPU0HePnNTUjpShBnynKCvrtWhN+haKbSp+QWXSxiTrW99HBfAl1MDQyWcukoEb9Cw6INctVUN4iRvkn9T8E6q174RbcnwA/7yTc7p1NCvw+6B/aAN9l1G2pQXgRdYC/+G6o1IZEHtWhqzE97nY5QKNuUVD0V09dc5CDYBaKjqetwwv6DFk/GRdOSEd/6bW+20z0qSHpa3YNW6qSp+x5pyYmDrzRIR03os6DauZkChSRyc/Whvurx6o85D6qpzywo8xwNaLZHxTQPgcIA5su9ZIytv9LH2E+lSwwIDAQABAoIBAFml8cD9a5pMqlW3f9btTQz1sRL4Fvp7CmHSXhvjsjeHwhHckEe0ObkWTRsgkTsm1XLu5W8IITnhn0+1iNr+78eB+rRGngdAXh8diOdkEy+8/Cee8tFI3jyutKdRlxMbwiKsouVviumoq3fxOGQYwQ0Z2l/PvCwy/Y82ffq3ysC5gAJsbBYsCrg14bQo44ulrELe4SDWs5HCjKYbEI2b8cOMucqZSOtxg9niLN/je2bo/I2HGSawibgcOdBms8k6TvsSrZMr3kJ5O6J+77LGwKH37brVgbVYvbq6nWPL0xLG7dUv+7LWEo5qQaPy6aXb/zbckqLqu6/EjOVeydG5JQECgYEA9kKfTZD/WEVAreA0dzfeJRu8vlnwoagL7cJaoDxqXos4mcr5mPDTkbWgFkLFFH/AyUnPBlK6BcJp1XK67B13ETUa3i9Q5t1WuZEobiKKBLFm9DDQJt43uKZWJxBKFGSvFrYPtGZst719mZVcPct2CzPjEgN3Hlpt6fyw3eOrnoECgYEAxiOujwXCOmuGaB7+OW2tR0PGEzbvVlEGdkAJ6TC/HoKM1A8r2u4hLTEJJCrLLTfw++4IddHE2dLeR4Q7O58SfLphwgPmLDezN7WRLGr7Vyfuv7VmaHjGuC3Gv9agnhWDlA2QgBG9/R9oVfL0Dc7CgJgLeUtItCYC31bGT3yhV0MCgYEA4k3DG4L+RN4PXDpHvK9IpA1jXAJHEifeHnaW1d3vWkbSkvJmgVf+9U5VeV+OwRHN1qzPZV4suRI6M/8lK8rAGr4UnM4aqK4K/qkY4G05LKrik9Ev2CgqSLQDRA7CJQ+Jn3Nb50qg6hFnFPafN+J77juWln08wFYV4Atpdd+9XQECgYBxizkZFL+9IqkfOcONvWAzGo+Dq1N0L3J4iTIkw56CKWXyj88d4qB4eUU3yJ4uB4S9miaW/eLEwKZIbWpUPFAn0db7i6h3ZmP5ZL8QqS3nQCb9DULmU2/tU641eRUKAmIoka1g9sndKAZuWo+o6fdkIb1RgObk9XNn8R4rpsv+aQKBgB+CIcExR30vycv5bnZN9EFlIXNKaeMJUrYCXcRQNvrnUIUBvAO8+jAeCdLygS5RtgOLZib0IVErqWsP3EI1ACGuLts0vQ9GFLQGaN1SaMS40C9kvns1mlDuLhIhYpJ8UsCVt5snWo2N+M+6ANh5tpWdQnEK6zILh4tRbuzaiHgb-----END RSA PRIVATE KEY-----]]>
                </PRIVATE_KEY>
                <UNIX_INSTALLATION_PATH>
                    <![CDATA[/opt/MarkLogic]]>
                </UNIX_INSTALLATION_PATH>
                <UNIX_CONF_PATH>
                    <![CDATA[/opt/MarkLogic]]>
                </UNIX_CONF_PATH>
                <WINDOW_INSTALLATION_PATH>
                    <![CDATA[C:\Program Files\MarkLogic]]>
                </WINDOW_INSTALLATION_PATH>
                <WINDOW_CONF_PATH>
                    <![CDATA[C:\Program Files\MarkLogic\Data]]>
                </WINDOW_CONF_PATH>
                <ADMIN_PORT>
                    <![CDATA[8002]]>
                </ADMIN_PORT>
                <ADMIN_SSL_VERIFY_WITH_HOST>
                    <![CDATA[1]]>
                </ADMIN_SSL_VERIFY_WITH_HOST>
                <ADMIN_HOSTS>
                    <![CDATA[host.domain1, host.domain2]]>
                </ADMIN_HOSTS>
                <LOGIN_TYPE>
                    <![CDATA[basic]]>
                </LOGIN_TYPE>
                <NETWORK_ID>0</NETWORK_ID>
                <CREATED>
                    <DATETIME>2024-07-02T08:01:23Z</DATETIME>
                    <BY>quay_sm</BY>
                </CREATED>
                <LAST_MODIFIED>
                    <DATETIME>2024-07-02T08:01:23Z</DATETIME>
                </LAST_MODIFIED>
            </AUTH_MARKLOGIC>
        </AUTH_MARKLOGIC_LIST>
    </RESPONSE>
</AUTH_MARKLOGIC_LIST_OUTPUT>

DTDs for markLogic records

Qualys API Server URL api/2.0/fo/auth/auth_marklogic_list_output.dtd