Management API XML schema

Content Platform Tenant Management Help

Version
9.7.x
File Size
4269 KB
Audience
anonymous
Part Number
MK-95HCPH002-19

HCP uses an XML schema to validate the XML in management API request bodies and to generate the XML in management API response bodies. To retrieve this schema from the HCP system, you use a URL with this format:

https://(tenant-name).hcp-domain-name:9090/static/mapi-9_3_0.xsd.xsd

To retrieve the schema, you need a tenant-level user account with the administrator role.

Here’s a sample curl command that retrieves the management API schema and writes it to a file named mapi_schema.xsd:

curl -k -i -H "Accept: application/xml"
    -H "Authorization: HCP YWxscm9sZXM=:04EC9F614D89FF5C7126D32ACB448382"
    "https://admin.hcp.example.com:9090/static/mapi-9_3_0.xsd"
    > mapi_schema.xsd