getmaintenancescheduleinfo.do

Veracode APIs

The getmaintenancescheduleinfo.do call requests the upcoming Veracode Platform maintenance schedule. Plan to pause scheduled API activity during the downtime to avoid automation failures.

Before using this API, Veracode strongly recommends that you read API Usage and Access Guidelines.

Resource URL

https://analysiscenter.veracode.com/api/3.0/getmaintenancescheduleinfo.do

Permissions

An API service account or user account.

Parameters

This call takes no parameters.

HTTPie Example

Examples use the HTTPie command-line tool. See Using HTTPie with the Python Authentication Library.

http --auth-type=veracode_hmac -o maintenancescheduleinfo.xml "https://analysiscenter.veracode.com/api/3.0/getmaintenancescheduleinfo.do"

HTTPie Results

The getmaintenancescheduleinfo.do call returns the maintenancescheduleinfo XML document, which references the maintenancescheduleinfo.xsd schema file. You can use the XSD schema file to validate the XML data. See the maintenancescheduleinfo.xsd schema documentation.

If the date in the XML return is in the past, Veracode has not yet scheduled the next maintenance window.

<?xml version="1.0" encoding="UTF-8"?>

<maintenancescheduleinfo xmlns:xsi="http&#x3a;&#x2f;&#x2f;www.w3.org&#x2f;2001&#x2f;XMLSchema-instance" 
      xmlns="https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;schema&#x2f;3.0&#x2f;maintenancescheduleinfo" 
      xsi:schemaLocation="https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;schema&#x2f;3.0&#x2f;maintenancescheduleinfo 
      https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;resource&#x2f;3.0&#x2f;maintenancescheduleinfo.xsd">
   <maintenanceschedule>
      <downtime_start>2019-08-28T16&#x3a;44&#x3a;42-04&#x3a;00</downtime_start>
      <downtime_end>2019-08-28T16&#x3a;44&#x3a;42-04&#x3a;00</downtime_end>
      <title>Scheduled Maintenance Notification</title>
      <description>The Veracode service will be unavailable due to maintenance.&#xa;We apologize for any inconvenience caused 
         during this period.&#xa; Please contact your primary services manager or Veracode Support 
         &#x28;&#x3c;a href&#x3d;&#x22;mailto&#x3a;support&#x40;veracode.com&#x22;&#x3e; 
         support&#x40;veracode.com&#x3c;&#x2f;a&#x3e;&#x29; if you have any questions.</description>
   </maintenanceschedule>
</maintenancescheduleinfo>