Note	The word Schema is alternately known as Profile in this guide.

For the examples in this guide, if an example does not specify a release number in the heading, it is applicable to release 1.0(1) and release 1.0(2).

The following is an example of how a user can login.

POST:

POST https://<host>:<port>/api/v1/auth/login

Request:

{
 "username": "bob",
 "password": "welcome"
}
 

Response:

HTTP/1.1 201 (Created)      -> Valid user credentials
{
  "userId": "592717d22000008b01db2749",
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.ey...fQ.QpfcqZdo-g-O0RGUmMZCVspIL7rYHjKJH0srX7Tl3wA",
  "permissions": [
    "view-sites",
    "manage-sites",
    "view-tenants",
    "manage-tenants"
  ]
}
 
HTTP/1.1 401(Unauthorized)   -> Invalid user credentials
{
  "code": 401,
  "message": "Invalid user credentials"
}

Note	This is the only API in Cisco ACI Multi-Site that does not require the Authorization header to be set. The token in the above example has been trimmed for readability.

The following is an example of how a user can logout.

DELETE:

DELETE https://<host>:<port>/api/v1/auth/logout

Request:

<empty>
 

Response:

HTTP/1.1 204

The following is an example of how to refresh a token.

GET:

GET https://<host>:<port>/api/v1/auth/refresh-token

Request:

<empty> 

Response:

HTTP/1.1 200
{
  "userId": "592717d22000008b01db2749",
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.ey...fQ.YVGLUtVZYfrMa-Bpf7gk281dZ4uPg20pk1QF6ffH63w",
  "permissions": [
    "view-sites",
    "manage-sites",
    "view-tenants",
    "manage-tenants"
  ]
}

Note	Tokens in Cisco ACI Multi-Site expire every 20 minutes. For longer interactions, this API provides an ability to obtain new tokens for subsequent interactions.

Once the user token has been returned from the initial login API POST, this token must be inserted into a Header key called “Authorization” with the value of “Bearer [Token_ID]” for all subsequent API calls.

The following is an example of how to use tokens on authentication on APIs. In this example, it is to get a list of tenants.

GET:

GET https://<host>:<port>/api/v1/tenants -H 'Authorization': 'Bearer {token}'

Request:

curl http://localhost/api/v1/tenants -H 'Authorization': 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.ey...fQ.QpfcqZdo-g-O0RGUmMZCVspIL7rYHjKJH0srX7Tl3wA'

The following is an example of how to authenticate and maintain an API session.

• Before you access the API, you must first log in with the username and password of a configured user.

• When a login message is accepted, the API returns a data structure that includes a token that represents the session, and it also returns the permissions of the user.

• The default timeout period is 20 minutes.

Login: Sent as a post message, this method logs in the user, and opens the session. A user object, with the name and password attributes and the response, contains a session token. A set of permissions given to this user are also returned as a part of the response body.

Refresh: Tokens in Multi-Site expire every 20 minutes. For longer interactions, this API provides an ability to obtain new tokens for subsequent interactions.

Starting with Cisco ACI Multi-Site, release 1.1(1), the APIs for external authentication are supported. Therefore, the external authenticatioin examples are applicable starting with release 1.1(1) only.

The following is an example of how to create a new RADIUS provider.

POST:

POST https://<host>:<port>/api/v1/auth/providers/radius

Request:

{
    "host": "10.23.237.168",
    "description": "ACS RADIUS Provider",
    "sharedSecret": "ins3965!",
    "port": 1812,
    "protocol": "PAP",
    "timeoutInSeconds": 10,
    "retries":5
}

Response:

HTTP/1.1 201
Location: /api/v1/auth/providers/radius/59cc163c1f00005400ab4ffd
{
    "id": "59cc163c1f00005400ab4ffd",
    "host": "10.23.237.168",
    "description": "Tacacs Provider - 1",
    "sharedSecret": "******",
    "port": 1812,
    "protocol": "PAP",
    "timeoutInSeconds": 10,
    "retries": 5
}

The following is an example of how to read RADIUS provider information.

GET:

GET https://<host>:<port>/api/v1/auth/providers/radius/59cc163c1f00005400ab4ffd

Request:

<empty >

Response:

HTTP/1.1 200
{
    "id": "59cc163c1f00005400ab4ffd",
    "host": "10.23.237.168",
    "description": "ACS RADIUS Provider",
    "sharedSecret": "******",
    "port": 1812,
    "protocol": "PAP",
    "timeoutInSeconds": 10,
    "retries": 5
}

The following is an example of how to list RADIUS providers.

GET:

GET https://<host>:<port>/api/v1/providers/radius

Request:

<empty>

Response:

HTTP/1.1 200
{
    "radiusProviders": [
        {
            "id": "59cc163c1f00005400ab4ffd",
            "host": "10.23.237.168",
            "description": "RADIUS",
            "sharedSecret": "******",
            "port": 1812,
            "protocol": "PAP",
            "timeoutInSeconds": 10,
            "retries": 5
        },
        {
            "id": "59cc19942100004a0077f85e",
            "host": "10.23.237.169",
            "description": "ACS RADIUS Provider",
            "sharedSecret": "******",
            "port": 1812,
            "protocol": "PAP",
            "timeoutInSeconds": 10,
            "retries": 5
        }
    ]
}

The following is an example of how to list all providers.

GET:

GET https://<host>:<port>/api/v1/providers

Request:

<empty>

Response:

HTTP/1.1 200
{
    "providers": [
        {
            "id": "59cc30942200005e0076c633",
            "host": "10.23.237.101",
            "providerType": "radius",
            "description": "RADIUS",
            "port": 1812,
            "protocol": "PAP",
            "timeoutInSeconds": 10,
            "retries": 5
        },
        {
            "id": "59cc3157220000780076c634",
            "host": "10.23.237.188",
            "providerType": "radius",
            "description": "RADIUS",
            "port": 1812,
            "protocol": "PAP",
            "timeoutInSeconds": 10,
            "retries": 5
        }
    ]
}

The following is an example of how to update an existing RADIUS provider.

PUT:

PUT https://<host>:<port>/api/v1/auth/providers/radius/59cc163c1f00005400ab4ffd

Request:

{
    "id": "59cc163c1f00005400ab4ffd",
    "host": "10.23.237.168",
    "description": "ACS RADIUS Provider",
    "sharedSecret": "ins3965!",
    "port": 1812,
    "protocol": "PAP",
    "timeoutInSeconds": 10,
    "retries": 3
}

Response:

HTTP/1.1 200
{
    "id": "59cc163c1f00005400ab4ffd",
    "host": "10.23.237.168",
    "description": "ACS RADIUS Provider",
    "sharedSecret": "******",
    "port": 1812,
    "protocol": "PAP",
    "timeoutInSeconds": 10,
    "retries": 3
}

The following is an example of how to delete a RADIUS provider.

DELETE:

DELETE https://<host>:<port>/api/v1/auth/providers/radius/59cc163c1f00005400ab4ffd

Request:

<empty>

Response:

HTTP/1.1 204

The following is an example of how to create a new TACACS provider.

POST:

POST https://<host>:<port>/api/v1/auth/providers/tacacs

Request:

{
    "host": "10.23.237.168",
    "description": "Tacacs Provider - 1",
    "sharedSecret": "ins3965!",
    "port": 49,
    "protocol": "PAP",
    "timeoutInSeconds": 10,
    "retries":5
}

Response:

HTTP/1.1 201
Location: /api/v1/auth/providers/tacacs/59cc163c1f00005400ab4ffd
{
    "id": "59cc163c1f00005400ab4ffd",
    "host": "10.23.237.168",
    "description": "Tacacs Provider - 1",
    "sharedSecret": "******",
    "port": 49,
    "protocol": "PAP",
    "timeoutInSeconds": 10,
    "retries": 5
}

The following is an example of how to read TACACS provider information.

GET:

GET https://<host>:<port>/api/v1/auth/providers/tacacs/59cc163c1f00005400ab4ffd

Request:

<empty >

Response:

HTTP/1.1 200
{
    "id": "59cc163c1f00005400ab4ffd",
    "host": "10.23.237.168",
    "description": "Tacacs Provider - 1",
    "sharedSecret": "******",
    "port": 49,
    "protocol": "PAP",
    "timeoutInSeconds": 10,
    "retries": 5
}

The following is an example of how to list TACACS providers.

GET:

GET https://<host>:<port>/api/v1/providers/tacacs

Request:

<empty>

Response:

HTTP/1.1 200
{
    "tacacsProviders": [
        {
            "id": "59cc163c1f00005400ab4ffd",
            "host": "10.23.237.168",
            "description": "Tacacs Provider - 1",
            "sharedSecret": "******",
            "port": 49,
            "protocol": "PAP",
            "timeoutInSeconds": 10,
            "retries": 5
        },
        {
            "id": "59cc19942100004a0077f85e",
            "host": "10.23.237.169",
            "description": "Tacacs Provider - 1",
            "sharedSecret": "******",
            "port": 49,
            "protocol": "PAP",
            "timeoutInSeconds": 10,
            "retries": 5
        }
    ]
}

The following is an example of how to update an existing TACACS provider.

PUT:

PUT https://<host>:<port>/api/v1/auth/providers/tacacs/59cc163c1f00005400ab4ffd

Request:

{
    "id": "59cc163c1f00005400ab4ffd",
    "host": "10.23.237.168",
    "description": "Tacacs Provider - 1",
    "sharedSecret": "ins3965!",
    "port": 49,
    "protocol": "PAP",
    "timeoutInSeconds": 10,
    "retries": 3
}

Response:

HTTP/1.1 200
{
    "id": "59cc163c1f00005400ab4ffd",
    "host": "10.23.237.168",
    "description": "Tacacs Provider - 1",
    "sharedSecret": "******",
    "port": 49,
    "protocol": "PAP",
    "timeoutInSeconds": 10,
    "retries": 3
}

The following is an example of how to delete a TACACS provider.

DELETE:

DELETE https://<host>:<port>/api/v1/auth/providers/tacacs/59cc163c1f00005400ab4ffd

Request:

<empty>

Response:

HTTP/1.1 204

The following is an example of how to create a new login domain.

POST:

POST https://<host>:<port>/api/v1/auth/domains

Request:

{
    "name" : "EngineeringGroup",
    "description" : "Used for RADIUS Auth Login",
    "realm" : "radius",
    "status": "active",
    "providerAssociations": [
    {
      "providerId": "59d5b4de8d0000ba00909f62",
      "priority" : 1
    }
  ]
}

Response:

HTTP/1.1 201
{
    "id": "59d6d0398d0000d2009eb2c4",
    "name": "EngineeringGroup",
    "description": "Used for RADIUS Auth Login",
    "realm": "radius",
    "status": "active",
    "providerAssociations": [
        {
            "providerId": "59d5b4de8d0000ba00909f62",
            "priority": 1
        }
    ]
}

The following is an example of how to list all active login domains.

Note	This is an unauthorized APIC for initial login.

GET:

GET https://<host>:<port>/api/v1/auth/login-domains

Request:

{
 {
    "domains": [
        {
            "id": "59d6d0398d0000d2009eb2c4",
            "name": "EngineeringGroup",
            "description": "Used for RADIUS Auth Login",
            "realm": "radius",
            "status": "active",
            "providerAssociations": []
        },
        {
            "id": "59d6cfb58d0000bd009eb2c3",
            "name": "VM-TACACS",
            "description": "Used for Tacacs Auth Login",
            "realm": "tacacs",
            "status": "active",
            "providerAssociations": []
        }
    ]
}
}

Note	The token in the above example has been truncated for readability.

The following is an example of how to list all login domains.

GET:

GET https://<host>:<port>/api/v1/auth/domains

Request:

{
 {
    "domains": [
        {
            "id": "59d6d0398d0000d2009eb2c4",
            "name": "EngineeringGroup",
            "description": "Used for RADIUS Auth Login",
            "realm": "radius",
            "status": "active",
            "providerAssociations": [
                {
                    "providerId": "59d5b4de8d0000ba00909f62",
                    "priority": 1
                },
                {
                    "providerId": "59d6d0988d0000cb009eb2c5",
                    "priority": 2
                }
            ]
        },
        {
            "id": "59d6cfb58d0000bd009eb2c3",
            "name": "VM-TACACS",
            "description": "Used for Tacacs Auth Login",
            "realm": "tacacs",
            "status": "active",
            "providerAssociations": [
                {
                    "providerId": "59d5b4de8d0000ba00909f62",
                    "priority": 1
                }
            ]
        }
    ]
}

The following is an example of how to list a login domain detail.

POST:

POST https://<host>:<port>/api/v1/auth/domains/59d2c88f9100000105b849e0 

Request:

{
    "id": "59d6d0398d0000d2009eb2c4",
    "name": "EngineeringGroup",
    "description": "Used for RADIUS Auth Login",
    "realm": "radius",
    "status": "active",
    "providerAssociations": [
        {
            "providerId": "59d5b4de8d0000ba00909f62",
            "priority": 1
        },
        {
            "providerId": "59d6d0988d0000cb009eb2c5",
            "priority": 2
        }
    ]
}

The following is an example of how to modify an existing login domain.

PUT:

PUT https://<host>:<port>/api/v1/auth/domains/59d6d0398d0000d2009eb2c4

Request:

{
    "id": "59d6d0398d0000d2009eb2c4",
    "name": "EngineeringGroup",
    "description": "Used for RADIUS Auth Login",
    "realm": "radius",
    "status": "active",
    "providerAssociations": [
        {
            "providerId": "59d5b4de8d0000ba00909f62",
            "priority": 1
        },
        {
            "providerId": "59d6d0988d0000cb009eb2c5",
            "priority": 2
        }       
    ]
}

The following is an example of how to modify an existing login domain.

PUT:

PUT https://<host>:<port>/api/v1/auth/domains/59d6d0398d0000d2009eb2c4

Request:

{
    "id": "59d6d0398d0000d2009eb2c4",
    "name": "EngineeringGroup",
    "description": "Used for RADIUS Auth Login",
    "realm": "radius",
    "status": "active",
    "providerAssociations": [
        {
            "providerId": "59d5b4de8d0000ba00909f62",
            "priority": 1
        },
        {
            "providerId": "59d6d0988d0000cb009eb2c5",
            "priority": 2
        }       
    ]
}

The following is an example of how to read and create remote user login domains.

POST:

POST https://<host>:<port>/api/v1/auth/login

Request:

{
 "username": "bob",
 "password": "we1come!",
 "domainId":"59d5b5978d0000d000909f65",
}

Response:

HTTP/1.1 201 (Created)      -> Valid user credentials
{
    "userId": "0000ffff0000000000000020",
    "needsPasswordUpdate": false,
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9....e-g308aqI8",
    "permissions": [
        "view-sites",
        "manage-sites",
        "view-tenants",
        "manage-tenants",
        "view-tenant-schemas",
        "manage-tenant-schemas",
        "view-schemas",
        "manage-schemas",
        "view-users",
        "manage-users",
        "view-roles",
        "manage-roles"
    ]
}
 
HTTP/1.1 401(Unauthorized)   -> Invalid user credentials
{
  "code": 401,
  "message": "Invalid user credentials"
}
  
HTTP/1.1 500(UnsupportedAuthType)   -> Authentication domain not supported
{
  "code": 500,
  "message": "Authentication domain not supported"
}

Note	This API does not require the Authorization header to be set. The token in the above example has been truncated for readability.

The following is an example of how to create a new label.

POST:

POST https://<host>:<port>/api/v1/labels 

Request:

{
  "name" : "devops",
  "type" : "site" 
}

Response:

HTTP/1.1 201
Location: /api/v1/labels/58202f7066e6e10001c41236
{
  "id": "58202f7066e6e10001c41236",
  "name" : "devops",
  "type" : "site"
}

The following is an example of how to read label information.

GET:

GET https://<host>:<port>/api/v1/labels/58202f7066e6e10001c41236

Request:

<empty>

Response:

HTTP/1.1 200
{
  "id": "58202f7066e6e10001c41236",
  "name" : "devops",
  "type" : "site"
}

The following is an example of how to update a label.

PUT:

PUT https://<host>:<port>/api/v1/labels/58202f7066e6e10001c41236

Request:

{
    "id": "58202f7066e6e10001c41236",
    "name" : "test",
    "type" : "site" 
}

Response:

HTTP/1.1 200
{
  "id": "58202f7066e6e10001c41236",
  "name" : "test",
  "type" : "site"
}

The following is an example of how to delete a label.

DELETE:

DELETE https://<host>:<port>/api/v1/labels/58202f7066e6e10001c41236

Request:

<empty>

Response:

HTTP/1.1 204

The following is an example of how to list labels.

GET:

GET https://<host>:<port>/api/v1/labels

Note	Filtering, pagination, and sorting is currently not supported.

Request:

<empty>

Response:

HTTP/1.1 200
{
  "labels": [
    {
      "id": "58202f7066e6e10001c41236",
      "name" : "devops",
      "type" : "site"    
    },
    {
      "id": "58202fc466e6e10001c41237",
      "name" : "prod",
      "type" : "site"
    }
  ]
}

The following is an example of how to read role information.

GET:

GET https://<host>:<port>/api/v1/role/591f58c1220000e406fa80b5 

Request:

<empty>

Response:

HTTP/1.1 200
{
  "id": "591f58c1220000e406fa80b5",
  "name": "role1",
  "displayName": "Role 1",
  "description": "Description for Role 1",
  "permissions": [
    "view-sites",
    "manage-sites",
    "view-tenants",
    "manage-tenants",
    "view-tenant-schemas",
    "view-schemas",
    "manage-schemas",
    "view-users",
    "manage-users",
    "view-roles",
    "manage-roles"
  ]
}

The following is an example of how to list roles.

GET:

GET https://<host>:<port>/api/v1/roles 

Request:

<empty>

Response:

HTTP/1.1 200
{
  "roles": [
    {
      "id": "591f58c1220000e406fa80b5",
      "name": "role1",
      "displayName": "Role 1",
      "description": "Description for Role 1",
      "permissions": [
        "view-sites",
        "manage-sites",
        "view-tenants",
        "manage-tenants",
        "view-tenant-schemas",
        "view-schemas",
        "manage-schemas",
        "view-users",
        "manage-users",
        "view-roles",
        "manage-roles"
      ]
    },
    {
      "id": "591f5903220000f106fa80b6",
      "name": "role2",
      "displayName": "Role 2",
      "description": "Description for Role 2",
      "permissions": [
        "view-sites",
        "manage-sites",
        "view-tenants",
        "manage-tenants"
      ]
    }
  ]
}

The following is an example of how to create a new user.

POST:

POST https://<host>:<port>/api/v1/users

 

Request:

{
 "username": "user1",
 "password": "Cisco@123!",
 "firstName": "Foo",
 "lastName": "Bar",
 "emailAddress": "noreply@cisco.com",
 "phoneNumber": "408-527-0000",
 "accountStatus": "active",
  "roles": [
    {
      "roleId": "591f5903220000f106fa80b6"
    }
  ]

Response:

HTTP/1.1 201
Location: /api/v1/users/58202f7066e6e10001c41236
{
  "id": "58202f7066e6e10001c41236",
  "username": "user1",
  "password": "******",
  "firstName": "Foo",
  "lastName": "Bar",
  "emailAddress": "noreply@cisco.com",
  "phoneNumber": "408-527-0000",
  "accountStatus": "active",
  "roles": [
    {
      "roleId": "591f5903220000f106fa80b6"
    }
  ]
}

The following is an example of how to reset the password for an existing user.

PUT:

PUT https://<host>:<port>/api/v1/users/58202f7066e6e10001c41236/reset-password

 

Request:

{
  "currentPassword": "Cisco@123!",
   "newPassword":    "Cisco@456!"
}

Response:

HTTP/1.1 200 OK

Note

If a user password is system generated or generated by a user-manager in Multi-Site, then upon login, that user (including the admin) will be required to reset their own password. The minimum requirements for the password field are as follows: Minimum 6 characters must be used At least one letter must be included At least one number must be included At least 1 special character must be used. But space and * are not supported.

The following is an example of how to read user information.

GET:

GET https://<host>:<port>/api/v1/users/58202f7066e6e10001c41236

 

Request:

<empty>

Response:

HTTP/1.1 200
{
  id": "58202f7066e6e10001c41236",
  "username": "user1",
  "password": "******",
  "firstName": "Foo",
  "lastName": "Bar",
  "emailAddress": "noreply@cisco.com",
  "phoneNumber": "408-527-0000",
  "accountStatus": "active",
  "roles": [
    {
      "roleId": "591f5903220000f106fa80b6"
    }
  ]
}

The following is an example of how to update an existing user.

PUT:

PUT https://<host>:<port>/api/v1/users/58202f7066e6e10001c41236

 

Request:

{
  id": "58202f7066e6e10001c41236",
  "username": "user1",
  "password": "******",
  "firstName": "Foo",
  "lastName": "Bar",
  "emailAddress": "noreply@cisco.com",
  "phoneNumber": "408-527-0000",
  "accountStatus": "active",
  "roles": [
    {
      "roleId": "591f58c1220000e406fa80b5"
    },
    {
      "roleId": "591f5903220000f106fa80b6"
    }
  ]
}

Response:

HTTP/1.1 200
{
  id": "58202f7066e6e10001c41236",
  "username": "user1",
  "password": "******",
  "firstName": "Foo",
  "lastName": "Bar",
  "emailAddress": "noreply@cisco.com",
  "phoneNumber": "408-527-0000",
  "accountStatus": "active",
  "roles": [
    {
      "roleId": "591f58c1220000e406fa80b5"
    },
    {
      "roleId": "591f5903220000f106fa80b6"
    }
  ]
}

The following is an example of how to delete a user.

DELETE:

DELETE https://<host>:<port>/api/v1/users/58202f7066e6e10001c41236

 

Request:

<empty>

Response:

HTTP/1.1 204

The following is an example of how to list users.

GET:

GET https://<host>:<port>/api/v1/users

 

Request:

<empty>

Response:

HTTP/1.1 200
{
  "users": [
    {
      "id": "58202f7066e6e10001c41236",
      "username": "user1",
      "password": "",
      "firstName": "Foo",
      "lastName": "Bar",
      "emailAddress": "noreply@cisco.com",
      "phoneNumber": "408-527-000",
      "accountStatus": "active",
      "roles": [
        {
          "roleId": "591f5903220000f106fa80b6"
        }
      ]
    },
    {
      "id": "58202fc466e6e10001c41237",
      "username": "user2",
      "password": "",
      "firstName": "Foo2",
      "lastName": "Bar2",
      "emailAddress": "noreply@cisco.com",
      "phoneNumber": "408-527-0000",
      "accountStatus": "Inactive",
      "roles": []
    }
  ]
}

The following is an example of how to list roles that may be associated with users.

GET:

GET https://<host>:<port>/api/v1/users/allowed-roles

 

Request:

<empty>

Response:

HTTP/1.1 200
{
  "roles": [
    {
      "id": "591f58c1220000e406fa80b5",
      "displayName": "Role 1",
      "permissions": [
        "view-sites",
        "manage-sites",
        "view-tenants",
        "manage-tenants",
        "view-tenant-schemas",
        "view-schemas",
        "manage-schemas",
        "view-users",
        "manage-users",
        "view-roles",
        "manage-roles"
      ]
    },
    {
      "id": "591f5903220000f106fa80b6",
      "displayName": "Role 2",
      "permissions": [
        "view-sites",
        "manage-sites",
        "view-tenants",
        "manage-tenants"
      ]
    }
  ]
}

The following is an example of how to retrieve roles associated with a user.

GET:

GET https://<host>:<port>/api/v1/users/58202f7066e6e10001c41236/roles

 

Request:

<empty>

Response:

HTTP/1.1 200
{
  "roles": [
    {
      "id": "591f58c1220000e406fa80b5",
      "displayName": "Role 1",
      "permissions": [
        "view-sites",
        "manage-sites",
        "view-tenants",
        "manage-tenants",
        "view-tenant-schemas",
        "view-schemas",
        "manage-schemas",
        "view-users",
        "manage-users",
        "view-roles",
        "manage-roles"
      ]
    }
  ]
}

The following is an example of how to retrieve permissions associated with a user.

GET:

GET https://<host>:<port>/api/v1/users/58202f7066e6e10001c41236/permissions

 

Request:

<empty>

Response:

HTTP/1.1 200
{
  "permissions": [
    "view-sites",
    "manage-sites",
    "view-tenants",
    "manage-tenants",
    "view-tenant-schemas",
    "view-schemas",
    "manage-schemas",
    "view-users",
    "manage-users",
    "view-roles",
    "manage-roles"
  ]
}

The following is an example of how to get an update for fabric connectivity.

PUT:

PUT https://<host>:<port>/api/v1/sites/fabric-connectivity

Request:

{
"controlPlaneBgpConfig" : {
    "peeringType" : "full-mesh | route-reflector",
    "ttl" : 16,
    "keepAliveInterval" : 60,
    "holdInterval" : 180,
    "staleInterval" : 300,  
    "gracefulRestartEnabled" : true,
    "maxAsLimit" : 0
  },
  "ospfPolicies" : [ {
    "name" : "msc-ospf-policy-default",
    "networkType" : "broadcast | point-to-point | unspecified",
    "priority" : 1,
    "interfaceCost" : 1,
    "interfaceControls" : [ "advertise-subnet", "mtu-ignore", "bfd", "passive-participation" ], //values are optional
    "helloInterval" : 10,
    "deadInterval" : 40,
    "retransmitInterval" : 5,
    "transmitDelay" : 1
  } ],
  "sites" : [ {
    "id" : "5935b0b633000088017723a4",
    "apicSiteId" : 1,
    "fabricId" : 1,
    "msiteEnabled" : true,  
    "msiteDataPlaneMulticastTep" : "11.30.1.1",
    "bgpAsn" : 1234,
    "bgpCommunity" : "extended:as2-nn4:4:15",
    "bgpPassword" : "",
    "ospfAreaId" : "57",      // Number or in IP address format
    "ospfAreaType" : "nssa | regular | stub",
    "ospfAreaCost" : 1,  
    "externalRoutedDomain" : "uni/l3dom-MultisiteL3Domain1-DoNotDelete",  
    "externalSubnetsToImport" : [ "20.23.10.0/16", "20.23.12.0/16"],
    "pods" : [ {
      "podId" : 1,
      "name" : "pod-1",    
      "msiteDataPlaneUnicastTep" : "11.20.1.1",
      "spines" : [ {
        "nodeId" : 201,
        "name" : "spine1",
        "ports" : [ {
          "portId" : "1/29",
          "ipAddress" : "20.23.10.1/24",
          "mtu" : "inherit",      // value is ‘inherit’ or number from range 576 to 9000        
          "routingPolicy" : "msc-ospf-policy-default"
        } ],      
        "bgpPeeringEnabled" : true,      
        "msiteControlPlaneTep" : "11.11.11.11",   
        "routeReflectorEnabled" : true,
          } ],
    } ],
  } ]
}
 

Response:

{
"controlPlaneBgpConfig" : {
    "peeringType" : "full-mesh | route-reflector",
    "ttl" : 16,
    "keepAliveInterval" : 60,
    "holdInterval" : 180,
    "staleInterval" : 300,  
    "gracefulRestartEnabled" : true,
    "maxAsLimit" : 0
  },
  "ospfPolicies" : [ {
    "name" : "msc-ospf-policy-default",
    "networkType" : "broadcast | point-to-point | unspecified",
    "priority" : 1,
    "interfaceCost" : 1,
    "interfaceControls" : [ "advertise-subnet", "mtu-ignore", "bfd", "passive-participation" ], // Array of strings.. values are optional.. those are all possible values
    "helloInterval" : 10,
    "deadInterval" : 40,
    "retransmitInterval" : 5,
    "transmitDelay" : 1
  } ],
  "sites" : [ {
    "id" : "5935b0b633000088017723a4",
    "apicSiteId" : 1,
    "fabricId" : 1,
    "msiteEnabled" : true,  
    "msiteDataPlaneMulticastTep" : "11.30.1.1",
    "bgpAsn" : 1234,
    "bgpCommunity" : "extended:as2-nn4:4:15",
    "bgpPassword" : "",
    "ospfAreaId" : "57",      // Number or in IP address format
    "ospfAreaType" : "nssa | regular | stub",
    "ospfAreaCost" : 1,  
    "externalRoutedDomain" : "uni/l3dom-MultisiteL3Domain1-DoNotDelete",  
    "externalSubnetsToImport" : [ "20.23.10.0/16", "20.23.12.0/16"],
    "pods" : [ {
      "podId" : 1,
      "name" : "pod-1",    
      "msiteDataPlaneUnicastTep" : "11.20.1.1",
      "spines" : [ {
        "nodeId" : 201,
        "name" : "spine1",
        "ports" : [ {
          "portId" : "1/29",
          "ipAddress" : "20.23.10.1/24",
          "mtu" : "inherit",      // value is ‘inherit’ or number from range 576 to 9000        
          "routingPolicy" : "msc-ospf-policy-default"
        } ],      
        "bgpPeeringEnabled" : true,      
        "msiteControlPlaneTep" : "11.11.11.11",   
        "routeReflectorEnabled" : true,        
      } ],
    } ],
  } ]
}

The following is an example of how to refresh fabric connectivity for a site.

GET:

GET https://<host>:<port>/api/v1/sites/:id/fabric-connnectivity/refresh

Example: GET /api/v1/sites/58dd77071200003600894510/fabric-connectivity/refresh

Request:

   <empty>

Response:

HTTP/1.1 200
{
    "id" : "5935b0b633000088017723a4",
    "apicSiteId" : 1,
    "fabricId" : 1,
    "msiteEnabled" : true,  
    "msiteDataPlaneMulticastTep" : "11.30.1.1",
    "bgpAsn" : 1234,
    "bgpCommunity" : "extended:as2-nn4:4:15",
    "bgpPassword" : "",
    "ospfAreaId" : "57",      // Number or in IP address format
    "ospfAreaType" : "nssa | regular | stub",
    "ospfAreaCost" : 1,  
    "externalRoutedDomain" : "uni/l3dom-MultisiteL3Domain1-DoNotDelete",  
    "externalSubnetsToImport" : [ "20.23.10.0/16", "20.23.12.0/16"],
    "pods" : [ {
      "podId" : 1,
      "name" : "pod-1",    
      "msiteDataPlaneUnicastTep" : "11.20.1.1",
      "spines" : [ {
        "nodeId" : 201,
        "name" : "spine1",
        "ports" : [ {
          "portId" : "1/29",
          "ipAddress" : "20.23.10.1/24",
          "mtu" : "inherit",      // value is ‘inherit’ or number from range 576 to 9000        
          "routingPolicy" : "msc-ospf-policy-default"
        } ],      
        "bgpPeeringEnabled" : true,      
        "msiteControlPlaneTep" : "11.11.11.11",   
        "routeReflectorEnabled" : true,        
      } ]   
}

The following is an example of how to get nodes.

GET:

GET https://<host>:<port>/api/v1/aci/sites/:id/nodes?type=<leaf,spine> 

Request:

<empty>

Response:

HTTP/1.1 200
{
    "nodes" : [ {
        "dn" : "topology/pod-1/node-101",
        "name" : "leaf1",
        "type" : "leaf"
    }, {
        "dn" : "topology/pod-1/node-102",
        "name" : "leaf2",
        "type" : "leaf"
    } ]
}

The following is an example of how to get physical interfaces details.

GET:

GET https://<host>:<port>/api/v1/aci/sites/:id/nodes/interfaces?node=<node_dn>&type=physical

Request:

<empty>

Response:

HTTP/1.1 200HTTP/1.1 200
{
  "interfaces": [
    {
      "dn": "topology/pod-1/paths-101/pathep-[eth1/1]",
      "name": "eth1/1",
      "type": "physical"
    },
    {
      "dn": "topology/pod-1/paths-101/pathep-[eth1/10]",
      "name": "eth1/10",
      "type": "physical"
    }
 ]
}

The following is an example of how to get physical interfaces, direct port channel type.

GET:

GET https://<host>:<port>/api/v1/aci/sites/:id/nodes/interfaces?type=dpc

Request:

<empty>

Response:

HTTP/1.1 200HTTP/1.1 200
{
  "interfaces": [
    {
      "dn": "topology/pod-1/paths-101/pathep-[Switch101_1-ports-3-4_PolGrp]",
      "name": "Switch101_1-ports-3-4_PolGrp",
      "type": "dpc"
    }
  ]
}

The following is an example of how to get physical interfaces, virtual port channel type.

GET:

GET https://<host>:<port>/api/v1/aci/sites/:id/nodes/interfaces?type=vpc

Request:

<empty>

Response:

HTTP/1.1 200HTTP/1.1 200
{
  "interfaces": [
    {
      "dn": "topology/pod-1/protpaths-101-102/pathep-[Switch101-102_1-ports-5_PolGrp]",
      "name": "Switch101-102_1-ports-5_PolGrp",
      "type": "vpc"
    }
  ]
}

The following is an example of how to create a Tenant.

POST:

POST https://<host>:<port>/api/v1/tenants

Request:

{
    "displayName": "Tenant 2",
    "name": "Tenant2",
    "description": "Description for Tenant 2",
    "siteAssociations": [
        {
        "siteId": "58dfeae2fd0000fd00cee617",
        "securityDomains": ["TestSecurityDomain", "domain-mgmt"]
        }
    ],
    "userAssociations": [
        { "userId": "58202f7066e6e10001c41236" }
        { "userId": "58202fc466e6e10001c41237" }
    ]
}

Response:

HTTP/1.1 201
Location: /api/v1/tenants/58202f7066e6e10001c41236
{
  "id": "58ed806aa10000bb0044da1e",
  "name": "Tenant2",
  "displayName": "Tenant 2",
  "description": "Description for Tenant 2",
  "siteAssociations": [
    {
      "siteId": "58dfeae2fd0000fd00cee617",
      "securityDomains": [
        "TestSecurityDomain",
        "mgmt"
      ]
    }
  ],
  "userAssociations": [
    { "userId": "58202f7066e6e10001c41236" }
    { "userId": "58202fc466e6e10001c41237" }
  ]
}

The following is an example of how to read Tenant information.

GET:

GET https://<host>:<port>/api/v1/tenants/58202f7066e6e10001c41236

Request:

<empty> 

Response:

HTTP/1.1 200
{
  "id": "58ed806aa10000bb0044da1e",
  "name": "Tenant2",
  "displayName": "Tenant 2",
  "description": "Description for Tenant 2",
  "siteAssociations": [
    {
      "siteId": "58dfeae2fd0000fd00cee617",
      "securityDomains": [
        "TestSecurityDomain",
        "mgmt"
      ]
    }
  ],
  "userAssociations": [
    { "userId": "58202f7066e6e10001c41236" }
    { "userId": "58202fc466e6e10001c41237" }
  ]
}

The following is an example of how to update an existing Tenant.

PUT:

PUT https://<host>:<port>/api/v1/tenants/58202f7066e6e10001c41236

Request:

{
  {
  "id": "58ed806aa10000bb0044da1e",
  "name": "Tenant2",
  "displayName": "Tenant 2 (Updated)",
  "description": "Description for Tenant 2",
  "siteAssociations": [
    {
      "siteId": "58dfeae2fd0000fd00cee617",
      "securityDomains": [
        "TestSecurityDomain",
        "mgmt"
      ]
    }
  ],
  "userAssociations": [
    { "userId": "58202f7066e6e10001c41236" }
    { "userId": "58202fc466e6e10001c41237" }
    { "userId": "58202fc466e6e10001c41238" }
  ]
}

Note	"id" is optional, other attributes are mandatory even if unchanged.

Response:

HTTP/1.1 200
{
    "id": "58ed806aa10000bb0044da1e",
    "displayName": "Tenant 2 (Updated)",
    "name": "Tenant2",
    "description": "Description for Tenant 2",
    "siteAssociations": [
        {
        "siteId": "58dfeae2fd0000fd00cee617",
        "securityDomains": ["TestSecurityDomain", "mgmt"]
        }
    ],
    "userAssociations": [
      { "userId": "58202f7066e6e10001c41236" }
      { "userId": "58202fc466e6e10001c41237" }
      { "userId": "58202fc466e6e10001c41238" }
    ]
}

The following is an example of how to delete a Tenant.

PUT:

DELETE https://<host>:<port>/api/v1/tenants/58202f7066e6e10001c41236

Request:

 <empty> 

Response:

HTTP/1.1 204

The following is an example of how to list Tenants.

PUT:

PUT https://<host>:<port>/api/v1/tenants/58202f7066e6e10001c41236

Request:

<empty>

Note	Filtering, pagination, and sorting is currently not supported.

Response:

HTTP/1.1 200
{
  "tenants": [
    {
      "id": "58ed7f22a10000a10044da19",
      "name": "test",
      "displayName": "test",
      "description": "Description for test",
      "siteAssociations": [
        {
          "siteId": "58dfeae2fd0000fd00cee617",
          "securityDomains": []
        }
      ],
      "userAssociations": [
      { "userId": "58202f7066e6e10001c41236" }
      { "userId": "58202fc466e6e10001c41237" }
      { "userId": "58202fc466e6e10001c41238" }
     ]
    },
    {
      "id": "58ed7f46a10000a50044da1a",
      "name": "Tenant1",
      "displayName": "Tenant 1",
      "description": "Description for Tenant 1",
      "siteAssociations": [
        {
          "siteId": "58dfeae2fd0000fd00cee617",
          "securityDomains": []
        }
      ],
      "userAssociations": [
      { "userId": "58202f7066e6e10001c41236" }
     ]
    },
    {
      "id": "58ed806aa10000bb0044da1e",
      "name": "Tenant2",
      "displayName": "Tenant 2 (Updated)",
      "description": "Description for Tenant 2",
      "siteAssociations": [
        {
          "siteId": "58dfeae2fd0000fd00cee617",
          "securityDomains": [
            "TestSecurityDomain",
            "mgmt"
          ]
        }
      ],
      "userAssociations": [
      { "userId": "58202f7066e6e10001c41236" }
     ]
    }
  ]
}

The following is an example of how to list sites associated with a Tenant.

GET:

GET /api/v1/tenants/allowed-sites

Request:

<empty>

Response:

HTTP/1.1 200
{
  "sites": [
    {
      "id": "591b6e5172040072044258ea",
      "name": "site1",
      "urls": [
        "https://10.23.236.232"
      ],
      "username": "admin",
      "password": "******",
      "siteId": "1"
    },
    {
      "id": "591b71353f00002700a2e8b1",
      "name": "site2",
      "urls": [
        "https://10.23.236.233"
      ],
      "username": "admin",
      "password": "******",
      "siteId": "2"
    }
  ]
}

The following is an example of how to list users associated with a Tenant.

GET:

GET /api/v1/tenants/allowed-users

Request:

<empty>

Response:

HTTP/1.1 200
{
  "users": [
    {
      "id": "0000ffff0000000000000020",
      "username": "admin",
      "password": "******",
      "firstName": "Admin",
      "lastName": "Admin",
      "emailAddress": "admin@msc.com",
      "phoneNumber": "(888) 123-4567",
      "accountStatus": "active",
      "roles": [
        {
          "roleId": "0000ffff0000000000000031"
        }
      ]
    },
    {
      "id": "593b12e62000004b00f13b21",
      "username": "bob",
      "password": "******",
      "firstName": "Bob",
      "lastName": "Smith",
      "emailAddress": "bob@gmail.com",
      "phoneNumber": "(888) 123-7890",
      "accountStatus": "active",
      "roles": [
        {
          "roleId": "0000ffff0000000000000034"
        }
      ]
    },
    {
      "id": "593b12f62000005200f13b22",
      "username": "russ",
      "password": "******",
      "firstName": "Russ",
      "lastName": "King",
      "emailAddress": "russ@gmail.com",
      "phoneNumber": "(800) 123-4545",
      "accountStatus": "active",
      "roles": [
        {
          "roleId": "0000ffff0000000000000033"
        },
        {
          "roleId": "0000ffff0000000000000035"
        },
        {
          "roleId": "0000ffff0000000000000032"
        }
      ]
    }
  ]
}

The following is an example of how to list Schemas associated with a Tenant.

GET:

GET /api/v1/tenants/:id/schemas

Request:

<empty>

Response:

{
  "schemas": [
    {
      "id": "594170153200003000a8b4fc",
      "displayName": "Schema 1",
      "templates": [],
      "sites": []
    },
    {
      "id": "594170153200003200a8b4fd",
      "displayName": "Schema 2",
      "templates": [],
      "sites": []
    },
    {
      "id": "594170153200003300a8b4ff",
      "displayName": "Schema 4",
      "templates": [],
      "sites": []
    }
  ]
}

The following is an example of how to list Schemas associated with all Tenants.

GET:

GET /api/v1/tenants/schemas

Request:

<empty>

Response:

{
  "tenants": {
    "59416f953200004c008cc048": [
      {
        "id": "59416f9532000030008cc04a",
        "displayName": "Schema 1",
        "templates": [],
        "sites": []
      },
      {
        "id": "59416f9532000033008cc04b",
        "displayName": "Schema 2",
        "templates": [],
        "sites": []
      },
      {
        "id": "59416f9532000033008cc04d",
        "displayName": "Schema 4",
        "templates": [],
        "sites": []
      }
    ],
    "59416f9532000036008cc049": [
      {
        "id": "59416f9532000052008cc04c",
        "displayName": "Schema 3",
        "templates": [],
        "sites": []
      },
      {
        "id": "59416f9532000033008cc04d",
        "displayName": "Schema 4",
        "templates": [],
        "sites": []
      }
    ]
  }
}

The following is an example of how to create a new Tenant network mapping.

PUT:

PUT /api/v1/tenants/:id/infra

Request:

{
  "externalEpgMappings": [
    {
      "siteMappings": [
        {
          "siteId": "59726e7a490000ea095b4cc8",
          "mapping": "uni/tn-Pepsi/out-L3Out-1/instP-Network"
        }
      ]
    }
  ]
}

Response:

HTTP/1.1 201
{
  "externalEpgMappings": [
    {
      "siteMappings": [
        {
          "siteId": "59726e7a490000ea095b4cc8",
          "mapping": "uni/tn-Pepsi/out-L3Out-1/instP-Network"
        }
      ]
    }
  ]
}

The following is an example of how to list existing Tenant network mappings.

GET:

GET /api/v1/tenants/:id/infra

Request:

<empty>

Response:

HTTP/1.1 201
{
  "externalEpgMappings": [
    {
      "siteMappings": [
        {
          "siteId": "59726e7a490000ea095b4cc8",
          "mapping": "uni/tn-Pepsi/out-L3Out-1/instP-Network"
        }
      ]
    }
  ]
}

The following is an example of a Schema health summary.

Note

This API call returns a summary of the health of all Schemas to which the currently logged in user has access. The summary includes aggregated health of all policies in a Schema that has been pushed to a site, on a per template/site basis, as well as template/tenant identity information. This API is used for the Policy Heatmap on the dashboard page in the GUI . Only Schemas that have been deployed will have health information.

GET

GET /api/v1/schemas/health-summary

REQUEST

  <empty>

RESPONSE

{
  "schemas": [
    {
      "id": "5969609c400000570068d69d",
      "schemaId": "5965bb96340000d800908add",
      "displayName": "Schema-Provider-AD",
      "templates": [
        {
          "name": "Template1",
          "displayName": "AD-Template-500"
        }
      ],
      "healthFaults": [
        {
          "siteId": "595e9796c00000c00000d632",
          "templateName": "Template1"
        }
      ]
    },
    {
      "id": "596e94253e00005f01347df0",
      "schemaId": "596e93c0860000e802274ac6",
      "displayName": "Common Schema",
      "templates": [
        {
          "name": "Simulator1CommonTenant",
          "displayName": "Simulator 1 Common Tenant"
        },
        {
          "name": "ifav87-site3",
          "displayName": "ifav87-site3"
        }
      ],
      "healthFaults": [
        {
          "siteId": "596d00644400008d00ca4ed0",
          "templateName": "Simulator1CommonTenant",
          "health": {
            "score": 100
          }
        },
        {
          "siteId": "596ff6e61f00007a002d1880",
          "templateName": "ifav87-site3",
          "health": {
            "score": 100
          }
        }
      ]
    },
    {
      "id": "5971314e2100007800076f36",
      "schemaId": "59713115850000230144a54f",
      "displayName": "T2 Schema",
      "templates": [
        {
          "name": "Template1",
          "displayName": "Template 1"
        }
      ],
      "healthFaults": [
        {
          "siteId": "596d00644400008d00ca4ed0",
          "templateName": "Template1"
        }
      ]
    }
  ]
}

The following is an example of how to sync health and fault information for all tenants in a schema from all the associated sites

GET

GET /api/v1/health/schemas/:schemaId/sync

REQUEST

  <empty>

RESPONSE

{
    "id": "5977ba963f0000de04760560",
    "schemaId": "5977ba913500006403c31911",
    "healthFaults": [
        {
            "siteId": "59726e7a490000ea095b4cc8",
            "templateName": "PespiTenant",
            "health": {
                "score": 100
            },
            "anps": [
                {
                    "anpRef": {
                        "schemaId": "5977ba913500006403c31911",
                        "templateName": "PespiTenant",
                        "anpName": "Pepsi-App"
                    },
                    "health": {
                        "score": 100
                    },
                    "faults": [],
                    "epgs": [
                        {
                            "epgRef": {
                                "schemaId": "5977ba913500006403c31911",
                                "templateName": "PespiTenant",
                                "anpName": "Pepsi-App",
                                "epgName": "App-EPG"
                            },
                            "health": {
                                "score": 100
                            },
                            "faults": []
                        }
                    ]
                }
            ],
            "vrfs": [
                {
                    "vrfRef": {
                        "schemaId": "5977ba913500006403c31911",
                        "templateName": "PespiTenant",
                        "vrfName": "TestVrf"
                    },
                    "health": {
                        "score": 100
                    },
                    "faults": []
                }
            ],
            "bds": [
                {
                    "bdRef": {
                        "schemaId": "5977ba913500006403c31911",
                        "templateName": "PespiTenant",
                        "bdName": "TestBD"
                    },
                    "health": {
                        "score": 100
                    },
                    "faults": []
                }
            ],
            "contracts": [
                {
                    "contractRef": {
                        "schemaId": "5977ba913500006403c31911",
                        "templateName": "PespiTenant",
                        "contractName": "TestContract"
                    },
                    "faults": []
                },
                {
                    "contractRef": {
                        "schemaId": "5977ba913500006403c31911",
                        "templateName": "PespiTenant",
                        "contractName": "TestContract2"
                    },
                    "faults": [
                        {
                            "type": "minor",
                            "message": "Configuration failed for Tenant Pepsi Contract TestContract2 due to Filter Not Present",
                            "code": "F1228"
                        }
                    ]
                }
            ]
        }
    ]
}

The following is an example of how to delete health and fault information for a schema.

GET

GET /api/v1/schemas/health-summary

REQUEST

  <empty>

RESPONSE

  <empty>

The following is an example for retrieving Schema health faults included.

Note

Health and Fault information is sideloaded with Schema configuration in a separate internal structure called "HealthFaults". This structure closely resembles the template structure in terms of hierarchy of policies, and it includes health information for policies that can have health (ANP, EPG, VRF, BD) and faults for all policies that can have faults (ANP, EPG, VRF, BD, Contract) . The HealthFaults structures exist on a per template/site basis. Health and fault data will only exist for policies that have been pushed.

GET

GET /api/v1/schemas/583c7c482501002501061985?include=health,faults

REQUEST

  <empty>

RESPONSE

HTTP/1.1 200
 
{
    "id": "5971480c1b000067319d7b3b",
    "displayName": "Schema 1",
    "templates": [
        {
            "name": "Template1",
            "displayName": "Template 1",
            "tenantId": "5952ebc21e00007b16c1a022",
            "anps": [
                {
                    "name": "ANP1",
                    "displayName": "ANP1",
                    "anpRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/anps/ANP1",
                    "epgs": [
                        {
                            "name": "EPG1",
                            "displayName": "EPG1",
                            "epgRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/anps/ANP1/epgs/EPG1",
                            "contractRelationships": [],
                            "subnets": [],
                            "uSegEpg": false,
                            "uSegAttrs": [],
                            "intraEpg": "unenforced",
                            "proxyArp": false,
                            "bdRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/bds/BD1"
                        }
                    ]
                }
            ],
            "vrfs": [
                {
                    "name": "VRF1",
                    "displayName": "VRF1",
                    "vrfRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/vrfs/VRF1"
                }
            ],
            "bds": [
                {
                    "name": "BD1",
                    "displayName": "BD1",
                    "bdRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/bds/BD1",
                    "l2UnknownUnicast": "proxy",
                    "intersiteBumTrafficAllow": true,
                    "optimizeWanBandwidth": false,
                    "l2Stretch": true,
                    "subnets": [],
                    "vrfRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/vrfs/VRF1"
                }
            ],
            "contracts": [
                {
                    "name": "Contract1",
                    "displayName": "Contract1",
                    "contractRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/contracts/Contract1",
                    "filterRelationships": [],
                    "scope": "context"
                },
                {
                    "name": "Contract2",
                    "displayName": "Contract2",
                    "contractRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/contracts/Contract2",
                    "filterRelationships": [
                        {
                            "filterRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/filters/Filter1",
                            "directives": [
                                "none"
                            ]
                        },
                        {
                            "filterRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/filters/Filter2",
                            "directives": [
                                "none"
                            ]
                        }
                    ],
                    "scope": "context"
                }
            ],
            "filters": [
                {
                    "name": "Filter1",
                    "displayName": "Filter1",
                    "filterRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/filters/Filter1",
                    "entries": []
                },
                {
                    "name": "Filter2",
                    "displayName": "Filter2",
                    "filterRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/filters/Filter2",
                    "entries": [
                        {
                            "name": "Entry1",
                            "displayName": "Entry1",
                            "description": "",
                            "etherType": "ip",
                            "ipProtocol": "tcp",
                            "matchOnlyFragments": false,
                            "stateful": false,
                            "sourceFrom": "unspecified",
                            "sourceTo": "unspecified",
                            "destinationFrom": "unspecified",
                            "destinationTo": "unspecified",
                            "tcpSessionRules": [
                                "unspecified"
                            ]
                        }
                    ]
                }
            ]
        }
    ],
    "sites": [
        {
            "siteId": "594b77e84400004000752a18",
            "templateName": "Template1",
            "anps": [],
            "vrfs": [],
            "bds": [],
            "contracts": []
        },
        {
            "siteId": "594b77dc4400004400752a17",
            "templateName": "Template1",
            "anps": [],
            "vrfs": [],
            "bds": [],
            "contracts": []
        }
    ],
    "healthFaults": [
        {
            "siteId": "594b77e84400004000752a18",
            "templateName": "Template1",
            "health": {
                "score": 100
            },
            "anps": [
                {
                    "anpRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/anps/ANP1",
                    "health": {
                        "score": 100
                    },
                    "faults": [
                        {
                            "type": "minor",
                            "message": "Configuration failed for EPG EPG1 due to BD IDs Not Allocated,Context IDs Not Allocated",
                            "code": "F0523"
                        }
                    ],
                    "epgs": [
                        {
                            "epgRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/anps/ANP1/epgs/EPG1",
                            "health": {
                                "score": 100
                            },
                            "faults": [
                                {
                                    "type": "minor",
                                    "message": "Configuration failed for EPG EPG1 due to BD IDs Not Allocated,Context IDs Not Allocated",
                                    "code": "F0523"
                                }
                            ]
                        }
                    ]
                }
            ],
            "vrfs": [
                {
                    "vrfRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/vrfs/VRF1",
                    "health": {
                        "score": 100
                    },
                    "faults": []
                }
            ],
            "bds": [
                {
                    "bdRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/bds/BD1",
                    "health": {
                        "score": 100
                    },
                    "faults": []
                }
            ],
            "contracts": [
                {
                    "contractRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/contracts/Contract1",
                    "faults": [
                        {
                            "type": "minor",
                            "message": "Configuration failed for Tenant DISA Contract Contract1 due to Filter Not Present",
                            "code": "F1228"
                        }
                    ]
                },
                {
                    "contractRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/contracts/Contract2",
                    "faults": []
                }
            ]
        },
        {
            "siteId": "594b77dc4400004400752a17",
            "templateName": "Template1",
            "health": {
                "score": 100
            },
            "anps": [
                {
                    "anpRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/anps/ANP1",
                    "health": {
                        "score": 100
                    },
                    "faults": [
                        {
                            "type": "minor",
                            "message": "Configuration failed for EPG EPG1 due to BD IDs Not Allocated",
                            "code": "F0523"
                        }
                    ],
                    "epgs": [
                        {
                            "epgRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/anps/ANP1/epgs/EPG1",
                            "health": {
                                "score": 100
                            },
                            "faults": [
                                {
                                    "type": "minor",
                                    "message": "Configuration failed for EPG EPG1 due to BD IDs Not Allocated",
                                    "code": "F0523"
                                }
                            ]
                        }
                    ]
                }
            ],
            "vrfs": [
                {
                    "vrfRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/vrfs/VRF1",
                    "health": {
                        "score": 100
                    },
                    "faults": []
                }
            ],
            "bds": [
                {
                    "bdRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/bds/BD1",
                    "health": {
                        "score": 100
                    },
                    "faults": []
                }
            ],
            "contracts": [
                {
                    "contractRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/contracts/Contract1",
                    "faults": [
                        {
                            "type": "minor",
                            "message": "Configuration failed for Tenant DISA Contract Contract1 due to Filter Not Present",
                            "code": "F1228"
                        }
                    ]
                },
                {
                    "contractRef": "/schemas/5971480c1b000067319d7b3b/templates/Template1/contracts/Contract2",
                    "faults": []
                }
            ]
        }
    ]
}

The following is an example for deleting a Schema.

DELETE

DELETE  https://<host>:<port>/api/v1/schemas/583c7c482501002501061985

REQUEST

DELETE
Request Body:
  <empty>
```

RESPONSE

HTTP/1.1 204

The following is an example for listing Schema identities.

GET

GET  https://<host>:<port>/api/v1/schemas/list-identity

Note	This provides a list of Schemas in the system with a few properties. Only template-tenant associations and template-site associations are returned. Policy configuration information in not included.

REQUEST

  <empty>

RESPONSE

HTTP/1.1 200
{
  "schemas": [
    {
      "id": "594b78792d00008000d5fb6f",
      "displayName": "Saad_Stretched",
      "templates": [
        {
          "name": "Template1",
          "displayName": "Template 3",
          "tenantId": "594b77c82d00006000d5fb6c",
          "anps": [],
          "vrfs": [],
          "bds": [],
          "contracts": [],
          "filters": []
        },
        {
          "name": "Template2",
          "displayName": "Template 2safsdf",
          "tenantId": "594b77c82d00006000d5fb6c",
          "anps": [],
          "vrfs": [],
          "bds": [],
          "contracts": [],
          "filters": []
        }
      ],
      "sites": [
        {
          "siteId": "594b77dc4400004400752a17",
          "templateName": "Template1",
          "anps": [],
          "vrfs": [],
          "bds": [],
          "contracts": []
        },
        {
          "siteId": "594b77e84400004000752a18",
          "templateName": "Template1",
          "anps": [],
          "vrfs": [],
          "bds": [],
          "contracts": []
        },
        {
          "siteId": "594b77e84400004000752a18",
          "templateName": "Template2",
          "anps": [],
          "vrfs": [],
          "bds": [],
          "contracts": []
        }
      ]
    },
    {
      "id": "594b790a2d0000a900d5fb70",
      "displayName": "SharedService",
      "templates": [
        {
          "name": "Template1",
          "displayName": "Template 1",
          "tenantId": "594b782d2d00006f00d5fb6d",
          "anps": [],
          "vrfs": [],
          "bds": [],
          "contracts": [],
          "filters": []
        }
      ],
      "sites": [
        {
          "siteId": "594b77dc4400004400752a17",
          "templateName": "Template1",
          "anps": [],
          "vrfs": [],
          "bds": [],
          "contracts": []
        }
      ]
    }
  ]
}

The following is an example for listing sites associated to a Schema.

GET

GET https://<host>:<port>/api/v1/schemas/allowed-sites

REQUEST

GET
Request Body:
  <empty>

RESPONSE

HTTP/1.1 200
{
  "sites": [
    {
      "id": "591b6e5172040072044258ea",
      "name": "site1",
      "urls": [
        "https://10.23.236.232"
      ],
      "username": "admin",
      "password": "******",
      "siteId": "1"
    },
    {
      "id": "591b71353f00002700a2e8b1",
      "name": "site2",
      "urls": [
        "https://10.23.236.233"
      ],
      "username": "admin",
      "password": "******",
      "siteId": "2"
    }
  ]
}

The following is an example of how to list Tenants that can be associated with a Schema.

POST:

POST  https://<host>:<port>/api/v1/schemas

Request:

<empty>

Response:

HTTP/1.1 200
{
  "tenants": [
    {
      "id": "591b6da1200000dc03b47a10",
      "name": "TenantA",
      "displayName": "Tenant A",
      "description": "Tenant A",
      "siteAssociations": [
        {
          "siteId": "591b6e5172040072044258ea",
          "securityDomains": []
        }
      ],
      "userAssociations": [
        {
          "userId": "0000ffff0000000000000020"
        },
        {
          "userId": "591b562f210000d000823836"
        }
      ]
    },
    {
      "id": "591b6e35200000f303b47a11",
      "name": "TenantB",
      "displayName": "Tenant B",
      "description": "Tenant B",
      "siteAssociations": [
        {
          "siteId": "591b6e5172040072044258ea",
          "securityDomains": []
        },
        {
          "siteId": "591b71353f00002700a2e8b1",
          "securityDomains": []
        }
      ],
      "userAssociations": [
        {
          "userId": "0000ffff0000000000000020"
        }
      ]
    }
  ]
}

The following is an example of how to list all Tenants associated to Schemas:

Endpoint:

https://<host>:<port>/api/v1/schemas/sites

Request:

  <empty>

Response:

  
 HTTP/1.1 200
{
  "tenants": [
    {
      "id": "0000ffff0000000000000010",
      "name": "common",
      "displayName": "common",
      "siteAssociations": [],
      "userAssociations": [
        {
          "userId": "0000ffff0000000000000020"
        }
      ],
      "description": "Common tenant for use with all other tenants"
    },
    {
      "id": "593b102322000088009ff785",
      "name": "TenantA",
      "displayName": "Tenant A",
      "siteAssociations": [
        {
          "siteId": "593b101169000069002de4c6",
          "securityDomains": [
            "TestSecurityDomain"
          ]
        }
      ],
      "userAssociations": [
        {
          "userId": "593b12e62000004b00f13b21"
        }
      ],
      "description": ""
    },
    {
      "id": "593b12cc2300002600eb63bd",
      "name": "TenantB",
      "displayName": "Tenant B",
      "siteAssociations": [
        {
          "siteId": "593b101169000069002de4c6",
          "securityDomains": []
        }
      ],
      "userAssociations": [
        {
          "userId": "593b12f62000005200f13b22"
        },
        {
          "userId": "593eba36210000140183e1a1"
        }
      ],
      "description": ""
    }
  ]
}

The following is an example of how to list Sites that can be associated with a Schema.

POST:

POST  https://<host>:<port>/api/v1/schemas/allowed-sites

Request:

<empty>

Response:

HTTP/1.1 200
{
  "sites": [
    {
      "id": "591b6e5172040072044258ea",
      "name": "site1",
      "urls": [
        "https://10.23.236.232"
      ],
      "username": "admin",
      "password": "******",
      "siteId": "1"
    },
    {
      "id": "591b71353f00002700a2e8b1",
      "name": "site2",
      "urls": [
        "https://10.23.236.233"
      ],
      "username": "admin",
      "password": "******",
      "siteId": "2"
    }
  ]

The following is an example of all Sites associated to Schemas.

POST:

POST  https://<host>:<port>/api/v1/schemas/sites

Request:

<empty>

Response:

HTTP/1.1 200
{
  "sites": [
    {
      "id": "591b6e5172040072044258ea",
      "name": "site1",
      "urls": [
        "https://10.23.236.232"
      ],
      "username": "admin",
      "password": "******",
      "siteId": "1"
    },
    {
      "id": "591b71353f00002700a2e8b1",
      "name": "site2",
      "urls": [
        "https://10.23.236.233"
      ],
      "username": "admin",
      "password": "******",
      "siteId": "2"
    }
  ]
}

The following is an example of how to list Tenants that can be associated with a Schema.

POST:

POST  https://<host>:<port>/api/v1/schemas/allowed-tenants

Request:

<empty>

Response:

HTTP/1.1 200
{
  "tenants": [
    {
      "id": "591b6da1200000dc03b47a10",
      "name": "TenantA",
      "displayName": "Tenant A",
      "description": "Tenant A",
      "siteAssociations": [
        {
          "siteId": "591b6e5172040072044258ea",
          "securityDomains": []
        }
      ],
      "userAssociations": [
        {
          "userId": "0000ffff0000000000000020"
        },
        {
          "userId": "591b562f210000d000823836"
        }
      ]
    },
    {
      "id": "591b6e35200000f303b47a11",
      "name": "TenantB",
      "displayName": "Tenant B",
      "description": "Tenant B",
      "siteAssociations": [
        {
          "siteId": "591b6e5172040072044258ea",
          "securityDomains": []
        },
        {
          "siteId": "591b71353f00002700a2e8b1",
          "securityDomains": []
        }
      ],
      "userAssociations": [
        {
          "userId": "0000ffff0000000000000020"
        }
      ]
    }
  ]
}

The following is an example of all Sites associated to Schemas.

POST:

POST  https://<host>:<port>/api/v1/schemas/sites

Request:

<empty>

Response:

HTTP/1.1 200
{
  "sites": [
    {
      "id": "591b6e5172040072044258ea",
      "name": "site1",
      "urls": [
        "https://10.23.236.232"
      ],
      "username": "admin",
      "password": "******",
      "siteId": "1"
    },
    {
      "id": "591b71353f00002700a2e8b1",
      "name": "site2",
      "urls": [
        "https://10.23.236.233"
      ],
      "username": "admin",
      "password": "******",
      "siteId": "2"
    }
  ]
}

The following is an example showing how to import a tenant from APIC.

GET

GET  https://<host>:<port>/api/v1/import/sites/:id/tenants/:tenantId/templates/:templateName

An example: /api/v1/import/sites/58b5f5ca390000390078e257/tenants/58b5f5ca390000390078e257/templates/template1

REQUEST

<empty>

RESPONSE

{
  "displayName": "",
  "templates": [
    {
      "name": "Template1",
      "displayName": "Template1",
      "tenantId": "5923588f800000e302e2a4fd",
      "anps": [
        {
          "name": "ANP1",
          "displayName": "ANP1",
          "anpRef": "/templates/Template1/anps/ANP1",
          "epgs": [
            {
              "name": "EPG1",
              "displayName": "EPG1",
              "epgRef": "/templates/Template1/anps/ANP1/epgs/EPG1",
              "contractRelationships": [
                {
                  "relationshipType": "provider",
                  "contractRef": "/templates/Template1/contracts/Contract1"
                }
              ],
              "subnets": [
                {
                  "ip": "10.0.0.1/24",
                  "scope": "private",
                  "shared": false
                },
                {
                  "ip": "5.5.5.5/21",
                  "scope": "private",
                  "shared": false
                }
              ],
              "uSegEpg": false,
              "uSegAttrs": [],
              "intraEpg": "unenforced",
              "bdRef": "/templates/Template1/bds/BD1"
            },
            {
              "name": "UntitledEPG1",
              "displayName": "UntitledEPG1",
              "epgRef": "/templates/Template1/anps/ANP1/epgs/UntitledEPG1",
              "contractRelationships": [],
              "subnets": [],
              "uSegEpg": false,
              "uSegAttrs": [],
              "intraEpg": "unenforced",
              "bdRef": "/templates/Template1/bds/BD1"
            }
          ]
        },
        {
          "name": "UntitledANP1",
          "displayName": "UntitledANP1",
          "anpRef": "/templates/Template1/anps/UntitledANP1",
          "epgs": [
            {
              "name": "EPG-Test",
              "displayName": "EPG-Test",
              "epgRef": "/templates/Template1/anps/UntitledANP1/epgs/EPG-Test",
              "contractRelationships": [],
              "subnets": [],
              "uSegEpg": false,
              "uSegAttrs": [],
              "intraEpg": "unenforced",
              "bdRef": "/templates/Template1/bds/BD1"
            }
          ]
        },
        {
          "name": "anp323",
          "displayName": "anp323",
          "anpRef": "/templates/Template1/anps/anp323",
          "epgs": [
            {
              "name": "sadfas",
              "displayName": "sadfas",
              "epgRef": "/templates/Template1/anps/anp323/epgs/sadfas",
              "contractRelationships": [],
              "subnets": [],
              "uSegEpg": false,
              "uSegAttrs": [],
              "intraEpg": "unenforced",
              "bdRef": "/templates/Template1/bds/BD1"
            }
          ]
        }
      ],
      "vrfs": [
        {
          "name": "VRF1",
          "displayName": "VRF1",
          "vrfRef": "/templates/Template1/vrfs/VRF1"
        },
        {
          "name": "VRF2",
          "displayName": "VRF2",
          "vrfRef": "/templates/Template1/vrfs/VRF2"
        }
      ],
      "bds": [
        {
          "name": "BD1",
          "displayName": "BD1",
          "bdRef": "/templates/Template1/bds/BD1",
          "l2UnknownUnicast": "proxy",
          "intersiteBumTrafficAllow": false,
          "l2Stretch": true,
          "subnets": [],
          "vrfRef": "/templates/Template1/vrfs/VRF1"
        }
      ],
      "contracts": [
        {
          "name": "Contract1",
          "displayName": "Contract1",
          "contractRef": "/templates/Template1/contracts/Contract1",
          "filterRelationships": [
            {
              "filterRef": "/templates/Template1/filters/Filter1",
              "directives": []
            }
          ],
          "scope": "global",
          "subjectName": "subj1"
        },
        {
          "name": "Contract2",
          "displayName": "Contract2",
          "contractRef": "/templates/Template1/contracts/Contract2",
          "filterRelationships": [
            {
              "filterRef": "/templates/Template1/filters/Filter2",
              "directives": []
            },
            {
              "filterRef": "/templates/Template1/filters/Filter3",
              "directives": []
            }
          ],
          "scope": "global",
          "subjectName": "msc-subject"
        },
        {
          "name": "Contract3",
          "displayName": "Contract3",
          "contractRef": "/templates/Template1/contracts/Contract3",
          "filterRelationships": [],
          "scope": "context",
          "subjectName": "msc-subject"
        }
      ],
      "filters": [
        {
          "name": "Filter1",
          "displayName": "Filter1",
          "filterRef": "/templates/Template1/filters/Filter1",
          "entries": []
        },
        {
          "name": "Filter2",
          "displayName": "Filter2",
          "filterRef": "/templates/Template1/filters/Filter2",
          "entries": [
            {
              "name": "Entry2",
              "displayName": "Entry2",
              "etherType": "ip",
              "arpFlag": "unspecified",
              "ipProtocol": "unspecified",
              "matchOnlyFragments": false,
              "stateful": false,
              "sourceFrom": "unspecified",
              "sourceTo": "unspecified",
              "destinationFrom": "unspecified",
              "destinationTo": "unspecified",
              "tcpSessionRules": [
                "unspecified"
              ]
            }
          ]
        },
        {
          "name": "Filter3",
          "displayName": "Filter3",
          "filterRef": "/templates/Template1/filters/Filter3",
          "entries": []
        }
      ]
    }
  ],
  "sites": [
    {
      "siteId": "591b427d820000a70055bbd5",
      "templateName": "Template1",
      "anps": [
        {
          "anpRef": "/templates/Template1/anps/ANP1",
          "epgs": [
            {
              "epgRef": "/templates/Template1/anps/ANP1/epgs/EPG1",
              "domainAssociations": [
                {
                  "dn": "uni/phys-testPhysicalDomain-DoNotDelete",
                  "domainType": "physicalDomain",
                  "deployImmediacy": "lazy",
                  "resolutionImmediacy": "lazy"
                },
                {
                  "dn": "uni/l3dom-TestL3Domain-DoNotDelete",
                  "domainType": "l3ExtDomain",
                  "deployImmediacy": "lazy",
                  "resolutionImmediacy": "lazy"
                },
                {
                  "dn": "uni/fc-TestFibreChannelDomain",
                  "domainType": "fibreChannelDomain",
                  "deployImmediacy": "lazy",
                  "resolutionImmediacy": "lazy"
                },
                {
                  "dn": "uni/l2dom-TestL2Domain-DoNotDelete",
                  "domainType": "l2ExtDomain",
                  "deployImmediacy": "lazy",
                  "resolutionImmediacy": "lazy"
                }
              ],
              "staticPorts": [
                {
                  "type": "port",
                  "path": "topology/pod-1/paths-101/pathep-[eth1/1]",
                  "portEncapVlan": 1234,
                  "deploymentImmediacy": "lazy",
                  "mode": "regular"
                }
              ],
              "staticLeafs": [
                {
                  "path": "topology/pod-1/node-101",
                  "portEncapVlan": 1234
                }
              ],
              "faults": []
            },
            {
              "epgRef": "/templates/Template1/anps/ANP1/epgs/UntitledEPG1",
              "domainAssociations": [
                {
                  "dn": "uni/vmmp-VMware/dom-Fab1-DVS1",
                  "domainType": "vmmDomain",
                  "deployImmediacy": "lazy",
                  "resolutionImmediacy": "immediate",
                  "vlanEncapMode": "dynamic",
                  "allowMicroSegmentation": true
                },
                {
                  "dn": "uni/vmmp-VMware/dom-TestDomain",
                  "domainType": "vmmDomain",
                  "deployImmediacy": "lazy",
                  "resolutionImmediacy": "immediate",
                  "portEncapVlan": {
                    "vlanType": "vlan",
                    "vlan": 3
                  },
                  "vlanEncapMode": "static",
                  "allowMicroSegmentation": false
                },
                {
                  "dn": "uni/vmmp-VMware/dom-TestDomain-DoNotDelete",
                  "domainType": "vmmDomain",
                  "deployImmediacy": "lazy",
                  "resolutionImmediacy": "immediate",
                  "microSegVlan": {
                    "vlanType": "vlan",
                    "vlan": 2
                  },
                  "portEncapVlan": {
                    "vlanType": "vlan",
                    "vlan": 1
                  },
                  "vlanEncapMode": "static",
                  "allowMicroSegmentation": true
                }
              ],
              "staticPorts": [
                {
                  "type": "dpc",
                  "path": "topology/pod-1/paths-101/pathep-[abc]",
                  "portEncapVlan": 1234,
                  "deploymentImmediacy": "lazy",
                  "mode": "regular"
                }
              ],
              "staticLeafs": [],
              "faults": []
            }
          ],
          "faults": []
        },
        {
          "anpRef": "/templates/Template1/anps/UntitledANP1",
          "epgs": [
            {
              "epgRef": "/templates/Template1/anps/UntitledANP1/epgs/EPG-Test",
              "domainAssociations": [
                {
                  "dn": "uni/vmmp-VMware/dom-TestDomain-DoNotDelete",
                  "domainType": "vmmDomain",
                  "deployImmediacy": "lazy",
                  "resolutionImmediacy": "immediate",
                  "portEncapVlan": {
                    "vlanType": "vlan",
                    "vlan": 243
                  },
                  "vlanEncapMode": "static",
                  "allowMicroSegmentation": false
                }
              ],
              "staticPorts": [],
              "staticLeafs": [],
              "faults": []
            }
          ],
          "faults": []
        },
        {
          "anpRef": "/templates/Template1/anps/anp323",
          "epgs": [
            {
              "epgRef": "/templates/Template1/anps/anp323/epgs/sadfas",
              "domainAssociations": [],
              "staticPorts": [
                {
                  "type": "vpc",
                  "path": "topology/pod-1/protpaths-101-102/pathep-[vpc1]",
                  "portEncapVlan": 1234,
                  "deploymentImmediacy": "lazy",
                  "mode": "regular"
                }
              ],
              "staticLeafs": [],
              "faults": []
            }
          ],
          "faults": []
        }
      ],
      "vrfs": [],
      "bds": [
        {
          "bdRef": "/templates/Template1/bds/BD1",
          "subnets": [],
          "faults": []
        }
      ],
      "contracts": [
        {
          "contractRef": "/templates/Template1/contracts/Contract1",
          "serviceGraphTemplate": {
            "name": "TestSGT"
          },
          "faults": []
        },
        {
          "contractRef": "/templates/Template1/contracts/Contract2",
          "serviceGraphTemplate": {
            "name": "TestSGT"
          },
          "faults": []
        },
        {
          "contractRef": "/templates/Template1/contracts/Contract3",
          "faults": []
        }
      ]
    }
  ],
  "messages": {
    "contractMessages": [
      {
        "contractRef": "/templates/Template1/contracts/Contract1",
        "message": "Contract has multiple subjects. Only the first subject is imported."
      }
    ],
    "vrfMessages": [
      {
        "vrfRef": "/templates/Template1/vrfs/VRF1",
        "message": "VRF contains vzAny contracts which are not imported."
      },
      {
        "vrfRef": "/templates/Template1/vrfs/VRF2",
        "message": "VRF contains vzAny contracts which are not imported."
      }
    ]
  }
}

The following is an example of how to create a new Site.

POST:

POST https://<host>:<port>/api/v1/sites

Request:

{
  "name": "APIC Site San Francisco",
  "urls": "http://16.105.47.201:8982/sf",
  "username": "admin",
  "password": "w3lcome3",
  "apicSiteId" : "1"
}

Response:

HTTP/1.1 201
Location: /api/v1/sites/58202f7066e6e10001c41236
{
  "id": "58202f7066e6e10001c41236",
  "name": "APIC Site San Francisco",
  "urls": "http://16.105.47.201:8982/sf",
  "username": "admin",
  "password": "w3lcome3",
  "siteId" : "1"
}

The following is an example of how to get basic information about a new Site:

Endpoint:

https://<host>:<port>/api/v1/sites/58202f7066e6e10001c41236

Request:

  GET
Request Body:
  <empty>

Response:

  HTTP/1.1 200
{
  "id": "58202f7066e6e10001c41236",
  "name": "APIC Site San Francisco",
  "urls": [
    "http://16.105.47.201:8982/sf"
  ],
  "username": "admin",
  "password": "******",
  "apicSiteId": "1"
}

The following is an example of how to get basic information about a new Site that also contains health faults:

Endpoint:

https://<host>:<port>/api/v1/sites/58202f7066e6e10001c41236?include=health,faults,cluster-status

Request:

  GET
Request Body:
  <empty>

Response:

  
HTTP/1.1 200
{
  "id": "58202f7066e6e10001c41236",
  "name": "APIC Site San Francisco",
  "urls": [
    "http://16.105.47.201:8982/sf"
  ],
  "username": "admin",
  "password": "******",
  "apicSiteId": "1",
  "labels" : ["58202f7066e6e10001c41240", "58202f7066e6e10001c41241"],
  "health": {
    "score": 97
  },
  "clusterStatus": [
    {
      "controllerId": 1,
      "controllerName": "apic1",
      "ipAddress": "10.0.0.1",
      "adminState": "in-service",
      "operationalState": "available",
      "health": "fully-fit"    
    },
    {
      "controllerId": 2,
      "controllerName": "apic2",
      "ipAddress": "10.0.0.2",
      "adminState": "in-service",
      "operationalState": "available",
      "health": "fully-fit"    
    },
    {
      "controllerId": 3,
      "controllerName": "apic3",
      "ipAddress": "10.0.0.3",
      "adminState": "in-service",
      "operationalState": "available",
      "health": "fully-fit"    
    }
  ],
 
  "faults": [
    {
      "count": 0,
      "type": "critical"
    },
    {
      "count": 2,
      "type": "major"
    },
    {
      "count": 736,
      "type": "minor"
    },
    {
      "count": 914,
      "type": "warning"
    }
  ]
}

The following is an example for updating an existing Site.

Endpoint:

https://<host>:<port>/api/v1/sites/58202f7066e6e10001c41236

Request

PUT
  {
  "id": "58202f7066e6e10001c41236",
  "name": "APIC Site San Francisco (Updated)",
  "urls": "http://16.105.47.201:8982/sf",
  "username": "root",
  "password": "w3lcome3",
  "apicSiteId" : "1"
}

Response

HTTP/1.1 200  
{
  "id": "58202f7066e6e10001c41236",
  "name": "APIC Site San Francisco (Updated)",
  "urls": "http://16.105.47.201:8982/sf",
  "username": "root",
  "password": "w3lcome3",
  "apicSiteId" : "1"
}

The following is an example of how to delete a Site:

Endpoint:

https://<host>:<port>/api/v1/sites/58202f7066e6e10001c41236

Request:

  DELETE
Request Body:
  <empty>

Response:

  
 HTTP/1.1 204
Response Body:
  <empty>

The following is an example of how to list all Sites:

Endpoint:

https://<host>:<port>/api/v1/sites

Request:

  GET
Request Body:
  <empty>

Response:

  HTTP/1.1 200
{
  "sites": [
    {
      "id": "58202f7066e6e10001c41236",
      "name": "APIC Site San Francisco",
      "urls": [
        "http://16.105.47.201:8982/sf"
      ],
      "username": "admin",
      "password": "******",
      "apicSiteId": "1"
    },
    {
      "id": "58202fc466e6e10001c41237",
      "name": "APIC Site San Jose",
      "urls": [
        "http://16.105.47.201:8982/sjc"
      ],
      "username": "root",
      "password": "******",
      "apicSiteId": "1"
    }
  ]
}

Note	Filtering, pagination, and sorting is currently not supported.

The following is an example of how to execute a Template under a Schema to its associated sites.

GET:

api/v1/execute/schema/{schema-id}/template/{template-name}

Request:

Response:

HTTP/1.1 200
{"msg":"Successfully deployed"}

The following is an example of how to undeploy a Template from its associated sites.

GET:

api/v1/execute/schema/{schema-id}/template/{template-name}?undeploy={site-id}

Request:

Response:

HTTP/1.1 200
{"msg":"Successfully deployed"}

The following is an example of how to list login domains.

List Domains:

GET https://<host>:<port>/api/v1/sites/:siteId/aci/domains?type=:type 

Example:

GET https://<host>:<port>/api/v1/sites/58202f7066e6e10001c41236/aci/domains?type=vmm 

Domain Types:

• vmm

• physical

• L2Ext

• l3Ext

• fibreChannel

Request:

{
  <empty>
}

Response:

{
  "domains": [
    {
      "name": "cSphere",
      "dn": "uni/vmmp-VMware/dom-cSphere"
    },
    {
      "name": "Fab1-DVS1",
      "dn": "uni/vmmp-VMware/dom-Fab1-DVS1"
    },
    {
      "name": "TestDomain-DoNotDelete",
      "dn": "uni/vmmp-VMware/dom-TestDomain-DoNotDelete"
    }
  ]
}

The following is an example for listing L3Outs.

GET:

GET https://<host>:<port>/api/v1/sites/:id/aci/tenants/:name/l3-outs

Request

{
  <empty>
}

Response

{
  "l3Outs": [
    {
      "name": "TestL3Out-DoNotDelete",
      "dn": "uni/tn-TestTenant-DoNotDelete/out-TestL3Out-DoNotDelete",
      "networkInstanceProfiles": [
        {
          "name": "TestNIP-1-DoNotDelete",
          "dn": "uni/tn-TestTenant-DoNotDelete/out-TestL3Out-DoNotDelete/instP-TestNIP-1-DoNotDelete"
        },
        {
          "name": "TestNIP-2-DoNotDelete",
          "dn": "uni/tn-TestTenant-DoNotDelete/out-TestL3Out-DoNotDelete/instP-TestNIP-2-DoNotDelete"
        }
      ]
    },
    {
      "name": "TestL3Out2",
      "dn": "uni/tn-TestTenant-DoNotDelete/out-TestL3Out2",
      "networkInstanceProfiles": [
        {
          "name": "N1",
          "dn": "uni/tn-TestTenant-DoNotDelete/out-TestL3Out2/Instp-N1"
        }
      ]
    }
  ]
}

The following is an example of how to read node information.

GET:

GET /api/v1/platform/nodes

Request:

<empty>

Response:

HTTP/1.1 200
{
    "nodes": [
        {
            "id": "cfihme4upn2yfpgadx7xyv9u7",
            "state": "ready",
            "ip": "192.168.65.2",
            "hostname": "moby"
        }
    ]
}

The following is an example of how to download troubleshooting report.

GET:

GET /api/v1/platform/logs?include=schemas,sites,tenants,users,infra_logs

Request:

<empty>

Response:

HTTP/1.1 200
zip file named msc_report_<timestamp>.zip

The following are examples of a few HTTP response codes:

400: Bad Request

{
  "code": 125,
  "info": {
    "obj.password": [
      "Missing path"
    ],
    "obj.username": [
      "Missing path"
    ],
    "obj.urls": [
      "Invalid urls"
    ]
  },
  "message": "Malformed body"
}

404: Entity not found or invalid endpoint

{
  "code": 404,
  "message": "Not Found"
}

409: Conflict - Duplicate entity/resource

{
  "code": 140,
  "message": "Duplicate Resource"
}

Starting with Cisco ACI Multi-Site, release 1.1(1), the API to create, read, and filter audit records is supported. Therefore, the auditing examples are applicable starting with release 1.1(1) only.

APIs listed in this section are granular and enable you to read and insert audit records across various Multi-Site entities.

Note	The auditing APIs are accessible only to administrators and users with the Power User role.

Downloading Audit Records: When downloading audit logs, one of the following APIs are invoked:

GET:

GET https://<host>:<port>/api/v1/audit-records/download?format=csv
GET https://<host>:<port>//api/v1/audit-records/download?format=csv

GET:

GET https://<host>:<port>/api/v1/audit-records?type=tenant 

Request:

<empty>

Response:

HTTP/1.1 200
{
  "auditRecords": [
    {
      "id": "59b5e11f1a0100270319b05e",
      "type": "tenant",
      "key": "59b5e11f3400004900c0ea97",
      "name": "Tenant 001",
      "event": "created",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "Admin User",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-09-10T01:04:31.701"
    },
    {
      "id": "59b5e11f1a0100270319b05e",
      "type": "tenant",
      "key": "59b5e11f3400004900c0ea97",
      "name": "Tenant 001",
      "event": "updated",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "Admin User",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-09-10T01:04:35.501"
    }
  ]
}

Filter Audit Records by container

The following are examples of container-type:

• tenant

• schema

• site

• fabric-connectivity-site

The following are examples of container-key:

• <id>

• <ref>

GET:

GET https://<host>:<port>/api/v1/audit-records?container-type=tenant&container-key=59b5e11f3400004900c0ea97

Request:

<empty>

Response:

HTTP/1.1 200
{
  "auditRecords": [
    {
      "id": "59b5e1561a0100300319b05f",
      "type": "tenant-site",
      "key": "59cbf2194500004500741bd3",
      "name": "Site 1",
      "event": "added",
      "container": {
        "type": "tenant",
        "key": "59b5e11f3400004900c0ea97",
        "name": "Tenant 001"
      },
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "Admin User",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-09-10T01:04:35.501"
    }
  ]
}

Filter Audit Records by container and context.

The following are examples of container-type:

Note	(Values are the same as "type" values)

• tenant

• schema

• site

The following are examples of container-key:

• <id>

• <ref>

The following are examples of context-type:

• site

• template

The following are examples of context-key:

• <id>

• <ref>

The following are examples of context-key:

GET:

GET https://<host>:<port>/api/v1/audit-records?container-type=<type>
&container-key=<key>&context-key=<key>&context-type=<type>&context-key=<key>  

GET https://<host>:<port>/api/v1/audit-records?container-type=tenant&container-key=
/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/
epgs/Web-EPG&context-type=site&context-key=/schemas/59ef87743800008e06881fe5/templates
/Template1/sites/59726e89490000ea095b4cc9

Request:

<empty>

Response:

HTTP/1.1 200
{
  "auditRecords": [
    {
            "id": "5a3aacc52100003d007f4c1a",
            "type": "attribute",
            "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/Web-EPG/subnets",
            "event": "added",
            "container": {
                "type": "epg",
                "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/Web-EPG",
                "name": "Web-EPG",
                "context": {
                    "type": "site",
                    "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/sites/59726e89490000ea095b4cc9",
                    "name": "New York"
                }
            },
            "newValue": "10.0.0.1/24",
            "user": {
                "userId": "0000ffff0000000000000020",
                "username": "admin",
                "firstName": "Admin",
                "lastName": "User",
                "domainId": "0000ffff0000000000000090",
                "domainName": "Local"
            },
            "timestamp": "2017-12-20T18:32:37"
        }
  ]
}

       

Filter Audit Records by username

GET:

GET https://<host>:<port>/api/v1/audit-records?username=admin   

GET:

GET https://<host>:<port>/api/v1/audit-records?username=admin,bob,lisa

Filter Audit Records by event

GET:

GET https://<host>:<port>/api/v1/audit-records?event=updated 

GET:

GET https://<host>:<port>//api/v1/audit-records?event=associated,added

Filter Audit Records by timestamp

GET:

GET https://<host>:<port>/api/v1/audit-records?timestamp=2017-09-10T01:04:31.701 

Filter Audit Records by date/time range

GET:

GET https://<host>:<port>/api/v1/audit-records?start=2017-09-10T01:04:31.701&end=2017-09-15T08:06:45.811

GET:

GET https://<host>:<port>/api/v1/audit-records?start=2017-09-10T07:00&end=2017-09-15T07:00

Combine multiple filters

GET:

GET https://<host>:<port>/api/v1/audit-records?username=admin&event=associated,added 

GET https://<host>:<port>/api/v1/audit-records?username=admin&start=2017-09-10T07:00&end=2017-09-15T07:00

The following is an example of how to paginate audit records.

Use the parameters offset and limit for this purpose. Both parameters are optional but defaults apply to every GET request that retrieves audit records. The default values are as follows:

• offset: 0

• limit: 20

Note	The maximum value for the limit is 250. The total number of records is available in the response header named "X-Total-Count". The prev and next "Link" headers are populated when applicable.

GET:

GET https://<host>:<port>/api/v1/audit-records?offset=3&limit=3 

Request:

<empty>

Response:

HTTP/1.1 200
Link: </api/v1/audit-records?offset=0&limit=3>; rel="prev", </api/v1/audit-records?offset=6&limit=3>; rel="next"
X-Total-Count: 76
{
  "auditRecords": [
    {
      "id": "59ed6de03d00003800175a2c",
      "type": "site",
      "key": "59ed6de04900004c00fcd96b",
      "name": "Site 1",
      "event": "created",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-23T04:19:44.355"
    },
    {
      "id": "59ed6de03d00003800175a2d",
      "type": "attribute",
      "key": "/sites/59ed6de04900004c00fcd96b/name",
      "event": "created",
      "container": {
        "type": "site",
        "key": "59ed6de04900004c00fcd96b",
        "name": "Site 1"
      },
      "newValue": "Site 1",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-23T04:19:44.355"
    },
    {
      "id": "59ed6de03d00003800175a2e",
      "type": "attribute",
      "key": "/sites/59ed6de04900004c00fcd96b/username",
      "event": "created",
      "container": {
        "type": "site",
        "key": "59ed6de04900004c00fcd96b",
        "name": "Site 1"
      },
      "newValue": "admin",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-23T04:19:44.355"
    }
  ]
}

Login Domains Auditing APIs are accessible by the following users with the following roles:

• admin

• Power User

• User and Role Manager

The Users Auditing APIs are accessible with the following roles:

• admin

• Power User

• User and Role Manager

The Providers Auditing APIs are accessible by the following users with the following roles:

• admin

• Power User

• User and Role Manager

Note	Default limit and offset values apply. Multiple additional filters (such as username, event, timestamp, date range) may be applied. Filters may also be combined.

The following example shows how to list or filter audit records for all Tenants. These APIs provide a high-level audit view of tenants that were created, updated, or deleted.

GET:

GET https://<host>:<port>/api/v1/tenants/audit-records 

GET https://<host>:<port>/api/v1/tenants/audit-records?offset=0&limit=3

GET https://<host>:<port>/api/v1/tenants/audit-records?username=admin&event=created,updated

Request:

<empty>

Response:

HTTP/1.1 200
{
  "auditRecords": [
    {
      "id": "59db14881e0000f00071f40e",
      "type": "tenant",
      "key": "59db147b2500000b01c90429",
      "name": "Tenant 001",
      "event": "updated",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-09T06:17:44.141"
    },
    {
      "id": "59db147c1e0000f00071f40c",
      "type": "tenant",
      "key": "59db147b2500000b01c90429",
      "name": "Tenant 001",
      "event": "created",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-09T06:17:31.873"
    },
    {
      "id": "59b5e11f1a0100270319b06a",
      "type": "tenant",
      "key": "59b5e11f3400004900c0ea98",
      "name": "Tenant 000",
      "event": "created",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-09-15T01:04:35.501"
    }
  ]
}

The following example shows how to list or filter a single Tenant's audit records.

GET:

GET https://<host>:<port>/api/v1/tenants/:id/audit-records 

GET https://<host>:<port>/api/v1/tenants/:id/audit-records?offset=0&limit=4

GET https://<host>:<port>/api/v1/tenants/:id/audit-records?username=admin&event=created,updated  

GET https://<host>:<port>/api/v1/tenants/:id/audit-records?timestamp=2017-09-15T01:04:35.501

Request:

<empty>

Response:

HTTP/1.1 200
{
  "auditRecords": [
    {
      "id": "59db14881e0000f00071f40f",
      "type": "attribute",
      "key": "/tenants/59db147b2500000b01c90429/description",
      "event": "updated",
      "container": {
        "type": "tenant",
        "key": "59db147b2500000b01c90429",
        "name": "Tenant 001"
      },
      "oldValue": "",
      "newValue": "Description for Tenant 001",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-09T06:17:44.141"
    },
    {
      "id": "59db14881e0000f00071f410",
      "type": "tenant-site",
      "key": "59d3f3254c00004c008172c5",
      "name": "Site 1",
      "event": "associated",
      "container": {
        "type": "tenant",
        "key": "59db147b2500000b01c90429",
        "name": "Tenant 001"
      },
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-09T06:17:44.141"
    },
    {
      "id": "59db14881e0000f00071f411",
      "type": "tenant-user",
      "key": "0000ffff0000000000000020",
      "name": "admin",
      "event": "associated",
      "container": {
        "type": "tenant",
        "key": "59db147b2500000b01c90429",
        "name": "Tenant 001"
      },
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-09T06:17:31.873"
    },
    {
      "id": "59db147c1e0000f00071f40d",
      "type": "attribute",
      "key": "/tenants/59db147b2500000b01c90429/displayName",
      "event": "created",
      "container": {
        "type": "tenant",
        "key": "59db147b2500000b01c90429",
        "name": "Tenant 001"
      },
      "oldValue": "",
      "newValue": "Tenant 001",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-09T06:17:31.873"
    }
  ]
}

The following example shows how to find all users associated with Tenant audit records.

GET:

GET https://<host>:<port>/api/v1/tenants/audit-records/users 

GET https://<host>:<port>/api/v1/tenants/:id/audit-records/users 

Request:

<empty>

Response:

HTTP/1.1 200
{
  "auditUsers": [
    {
      "userId": "0000ffff0000000000000020",
      "username": "admin",
      "firstName": "Admin",
      "lastName": "User",
      "domainId": "0000ffff0000000000000090",
      "domainName": "Local"
    },
    {
      "userId": "59ed6de03d00003800175a2e",
      "username": "bob",
      "firstName": "Bob",
      "lastName": "Smith",
      "domainId": "0000ffff0000000000000090",
      "domainName": "Local"
    }
  ]
}

Note

Default limit and offset values apply. Multiple additional filters (such as username, event, timestamp, date range) may be applied. Filters may also be combined. This is a powerful API, and it allows you to filter records related to, for example, all ANPs in a template, a particular ANP, or all policies in a template.

The following example shows how to list or filter audit records for all Schemas. These APIs provide a high-level audit view of schemas that were created, updated, or deleted.

GET:

GET https://<host>:<port>/api/v1/schemas/audit-records 

GET https://<host>:<port>/api/v1/schemas/audit-records?offset=0&limit=3

GET https://<host>:<port>/api/v1/schemas/audit-records?username=admin&event=created,updated

Request:

<empty>

Response:

HTTP/1.1 200
{
  "auditRecords": [
    {
      "id": "59ef87953a00001f069baf83",
      "type": "schema",
      "key": "59ef87743800008e06881fe5",
      "name": "Test Schema",
      "event": "updated",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:57.37"
    },
    {
      "id": "59ef87743a000022069baf60",
      "type": "schema",
      "key": "59ef87743800008e06881fe5",
      "name": "Test Schema",
      "event": "created",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    }
  ]
}

The following example shows how to list or filter a single Schema audit records. It shows audit records generated by a single schema.

GET:

GET https://<host>:<port>/api/v1/schemas/:id/audit-records 

GET https://<host>:<port>/api/v1/schemas/:id/audit-records?offset=0&limit=4

GET https://<host>:<port>/api/v1/schemas/:id/audit-records?username=admin&event=created,updated

Request:

<empty>

Response:

HTTP/1.1 200
 
{
  "auditRecords": [
    {
      "id": "59ef87743a000022069baf60",
      "type": "schema",
      "key": "59ef87743800008e06881fe5",
      "name": "Test Schema",
      "event": "created",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf61",
      "type": "template",
      "key": "schemas/59ef87743800008e06881fe5/templates/Template1",
      "name": "Template 1",
      "event": "added",
      "container": {
        "type": "schema",
        "key": "59ef87743800008e06881fe5",
        "name": "Test Schema"
      },
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf62",
      "type": "attribute",
      "key": "schemas/59ef87743800008e06881fe5/templates/Template1/displayName",
      "event": "created",
      "container": {
        "type": "template",
        "key": "schemas/59ef87743800008e06881fe5/templates/Template1",
        "name": "Template 1"
      },
      "newValue": "Template 1",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf63",
      "type": "anp",
      "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1",
      "name": "App-1",
      "event": "created",
      "container": {
        "type": "template",
        "key": "schemas/59ef87743800008e06881fe5/templates/Template1",
        "name": "Template 1"
      },
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf64",
      "type": "attribute",
      "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/displayName",
      "event": "created",
      "container": {
        "type": "anp",
        "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1",
        "name": "App-1"
      },
      "newValue": "App-1",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf65",
      "type": "epg",
      "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/Web-EPG",
      "name": "Web-EPG",
      "event": "created",
      "container": {
        "type": "template",
        "key": "schemas/59ef87743800008e06881fe5/templates/Template1",
        "name": "Template 1"
      },
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf66",
      "type": "attribute",
      "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/Web-EPG/displayName",
      "event": "created",
      "container": {
        "type": "epg",
        "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/Web-EPG",
        "name": "Web-EPG"
      },
      "newValue": "Web-EPG",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf67",
      "type": "attribute",
      "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/Web-EPG/uSegEpg",
      "event": "created",
      "container": {
        "type": "epg",
        "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/Web-EPG",
        "name": "Web-EPG"
      },
      "newValue": "false",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf68",
      "type": "attribute",
      "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/Web-EPG/intraEpg",
      "event": "created",
      "container": {
        "type": "epg",
        "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/Web-EPG",
        "name": "Web-EPG"
      },
      "newValue": "unenforced",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf69",
      "type": "attribute",
      "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/Web-EPG/proxyArp",
      "event": "created",
      "container": {
        "type": "epg",
        "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/Web-EPG",
        "name": "Web-EPG"
      },
      "newValue": "false",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf6a",
      "type": "attribute",
      "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/Web-EPG/bdRef",
      "event": "associated",
      "container": {
        "type": "epg",
        "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/Web-EPG",
        "name": "Web-EPG"
      },
      "newValue": "/schemas/59ef87743800008e06881fe5/templates/Template1/bds/BD1",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf6b",
      "type": "epg",
      "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/DB-EPG",
      "name": "DB-EPG",
      "event": "created",
      "container": {
        "type": "template",
        "key": "schemas/59ef87743800008e06881fe5/templates/Template1",
        "name": "Template 1"
      },
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf6c",
      "type": "attribute",
      "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/DB-EPG/displayName",
      "event": "created",
      "container": {
        "type": "epg",
        "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/DB-EPG",
        "name": "DB-EPG"
      },
      "newValue": "DB-EPG",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf6d",
      "type": "attribute",
      "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/DB-EPG/uSegEpg",
      "event": "created",
      "container": {
        "type": "epg",
        "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/DB-EPG",
        "name": "DB-EPG"
      },
      "newValue": "false",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf6e",
      "type": "attribute",
      "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/DB-EPG/intraEpg",
      "event": "created",
      "container": {
        "type": "epg",
        "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/DB-EPG",
        "name": "DB-EPG"
      },
      "newValue": "unenforced",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf6f",
      "type": "attribute",
      "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/DB-EPG/proxyArp",
      "event": "created",
      "container": {
        "type": "epg",
        "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/DB-EPG",
        "name": "DB-EPG"
      },
      "newValue": "false",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf70",
      "type": "attribute",
      "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/DB-EPG/bdRef",
      "event": "associated",
      "container": {
        "type": "epg",
        "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/anps/App-1/epgs/DB-EPG",
        "name": "DB-EPG"
      },
      "newValue": "/schemas/59ef87743800008e06881fe5/templates/Template1/bds/BD1",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf71",
      "type": "bd",
      "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/bds/BD1",
      "name": "BD1",
      "event": "created",
      "container": {
        "type": "template",
        "key": "schemas/59ef87743800008e06881fe5/templates/Template1",
        "name": "Template 1"
      },
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf72",
      "type": "attribute",
      "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/bds/BD1/displayName",
      "event": "created",
      "container": {
        "type": "bd",
        "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/bds/BD1",
        "name": "BD1"
      },
      "newValue": "BD1",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf73",
      "type": "attribute",
      "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/bds/BD1/l2UnknownUnicast",
      "event": "created",
      "container": {
        "type": "bd",
        "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/bds/BD1",
        "name": "BD1"
      },
      "newValue": "proxy",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf74",
      "type": "attribute",
      "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/bds/BD1/intersiteBumTrafficAllow",
      "event": "created",
      "container": {
        "type": "bd",
        "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/bds/BD1",
        "name": "BD1"
      },
      "newValue": "true",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf75",
      "type": "attribute",
      "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/bds/BD1/optimizeWanBandwidth",
      "event": "created",
      "container": {
        "type": "bd",
        "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/bds/BD1",
        "name": "BD1"
      },
      "newValue": "true",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf76",
      "type": "attribute",
      "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/bds/BD1/l2Stretch",
      "event": "created",
      "container": {
        "type": "bd",
        "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/bds/BD1",
        "name": "BD1"
      },
      "newValue": "true",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf77",
      "type": "attribute",
      "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/bds/BD1/vrfRef",
      "event": "associated",
      "container": {
        "type": "bd",
        "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/bds/BD1",
        "name": "BD1"
      },
      "newValue": "/schemas/59ef87743800008e06881fe5/templates/Template1/vrfs/VRF1",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    },
    {
      "id": "59ef87743a000022069baf78",
      "type": "attribute",
      "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/bds/BD1/subnets",
      "event": "added",
      "container": {
        "type": "bd",
        "key": "/schemas/59ef87743800008e06881fe5/templates/Template1/bds/BD1",
        "name": "BD1"
      },
      "newValue": "10.0.0.1/24",
      "user": {
        "userId": "0000ffff0000000000000020",
        "username": "admin",
        "firstName": "Admin",
        "lastName": "User",
        "domainId": "0000ffff0000000000000090",
        "domainName": "Local"
      },
      "timestamp": "2017-10-24T18:33:24.584"
    }
  ]
}

The following example shows how to find all users associated with Schema audit records.

GET:

GET https://<host>:<port>/api/v1/schema/audit-records/users 

GET https://<host>:<port>/api/v1/schema/:id/audit-records/users
 

Request:

<empty>

Response:

HTTP/1.1 200
{
  "auditUsers": [
    {
      "userId": "0000ffff0000000000000020",
      "username": "admin",
      "firstName": "Admin",
      "lastName": "User",
      "domainId": "0000ffff0000000000000090",
      "domainName": "Local"
    },
    {
      "userId": "59ed6de03d00003800175a2e",
      "username": "bob",
      "firstName": "Bob",
      "lastName": "Smith",
      "domainId": "0000ffff0000000000000090",
      "domainName": "Local"
    }
  ]
}

The following example shows how to list or filter audit records for fabric-connectivity. This example provides a high-level audit view of updates for fabric-connectivity.

Note	Default limit and offset values apply. Multiple additional filters (such as username, event, timestamp, date range) may be applied. Filters may also be combined.

GET:

GET https://<host>:<port>/api/v1/sites/fabric-connectivity/audit-records 

GET https://<host>:<port>/api/v1/sites/fabric-connectivity/audit-records?offset=0&limit=3

GET https://<host>:<port>/api/v1/sites/fabric-connectivity/audit-records?username=admin&event=created,updated

Request:

The following example shows how to find all users associated with Fabric-Connectivity audit records.

GET:

GET /api/v1/sites/fabric-connectivity/audit-records/users 

Starting with Cisco ACI Multi-Site, release 1.1(1), the APIs for backup are supported. Therefore, the backup examples are applicable starting with release 1.1(1) only.

The following is an example of how to create a new backup.

POST:

POST https://<host>:<port>/api/v1/backups

Request:

{
    "name": "testFile3",
    "description": "this is optional key value"

Response:

HTTP/1.1 201
Location: /api/v1/backups/20171116221404
{
    "id": "20171116221404",
    "sizeKB": 18.44,
    "timestamp": "2017-11-16T22:14:04",
    "metadata": {
        "description": "test-description",
        "name": "Check_20171116221404"
    }
}

The following is an example of how to list backups.

GET:

GET https://<host>:<port>/api/v1/backups

Request:

<empty>

Response:

HTTP/1.1 200
{
    "backups": [
        {
            "id": "20171116221404",
            "sizeKB": 18.44,
            "timestamp": "2017-11-16T22:14:04",
            "metadata": {
                "description": "test-description",
                "name": "Check_20171116221404"
            }
        },
        {
            "id": "20171116221721",
            "sizeKB": 18.55,
            "timestamp": "2017-11-16T22:17:21",
            "metadata": {
                "description": "test-description",
                "name": "Check_20171116221721"
            }
        },
        {
            "id": "20171116221724",
            "sizeKB": 19.11,
            "timestamp": "2017-11-16T22:17:24",
            "metadata": {
                "description": "test-description",
                "name": "Check_20171116221724"
            }
        },
        {
            "id": "20171116224425",
            "sizeKB": 18.99,
            "timestamp": "2017-11-16T22:44:25",
            "metadata": {
                "description": "test-description",
                "name": "Check_20171116224425"
            }
        },
        {
            "id": "20171127071624",
            "sizeKB": 24.72,
            "timestamp": "2017-11-27T07:16:24",
            "metadata": {
                "name": "testFile3_20171127071624"
            }
        },
        {
            "id": "20171127071655",
            "sizeKB": 28.08,
            "timestamp": "2017-11-27T07:16:55",
            "metadata": {
                "description": "this is optional key value",
                "name": "testFile3_20171127071655"
            }
        }
    ]
}

The following is an example of how to list a backup.

GET:

GET https://<host>:<port>/api/v1/backups/:id

Request:

<empty>

Response:

HTTP/1.1 200
{
            "id": "20170926231729",
            "sizeKB": 1.91,
            "dateTime": "2017-09-26T23:17:29",
            "metadata": {
                "description": "Right before zip review"
            }
}

The following is an example of how to download a backup.

GET:

GET https://<host>:<port>/api/v1/backups/:id/download

Request:

<empty>

Response:

HTTP/1.1 200
Binary output as it is a file

The following is an example of how to upload a backup.

GET:

GET https://<host>:<port>/api/v1/backups/:id/upload

Request:

form-data
key: name
value: valid tar.gz filename

Response:

HTTP/1.1 200
{
    "id": "20171127071655",
    "sizeKB": 28.08,
    "timestamp": "2017-11-27T07:16:55",
    "metadata": {
        "description": "this is optional key value",
        "name": "testFile3_20171127071655"
    }
}