API Guide

Chapter 1: Revision history.............................................................................................................. 7
Chapter 2: Using the REST API........................................................................................................ 8
Chapter 3: About............................................................................................................................ 9
GET /about............................................................................................................................................................................ 9
Chapter 4: Alerts............................................................................................................................11
GET /alerts............................................................................................................................................................................ 11
POST /alerts/{id}/ack........................................................................................................................................................ 13
POST /alerts/{id}/unack....................................................................................................................................................14
POST /alerts/{id}/clear......................................................................................................................................................15
GET /alerts/{id}/events.....................................................................................................................................................16
Chapter 5: Authentication.............................................................................................................. 18
POST /auth/token.............................................................................................................................................................. 18
POST /auth/token/extend................................................................................................................................................ 19
GET /auth/users..................................................................................................................................................................21
POST /auth/users.............................................................................................................................................................. 22
GET /auth/users/{userId}.................................................................................................................................................23
PUT /auth/users/{userId}.................................................................................................................................................25
DELETE /auth/users/{userId}..........................................................................................................................................26
PUT /auth/users/{userId}/password..............................................................................................................................28
PUT /auth/users/self/password......................................................................................................................................29
PUT /auth/users/{userId}/cli-access.............................................................................................................................. 31
PUT /auth/users/{userId}/user-role............................................................................................................................... 33
PUT /auth/users/{userId}/user-state.............................................................................................................................34
GET /auth/domains............................................................................................................................................................36
GET /auth/servers/ldap.................................................................................................................................................... 37
PUT /auth/servers/ldap.................................................................................................................................................... 38
DELETE /auth/servers/ldap............................................................................................................................................. 39
Chapter 6: Configuration................................................................................................................41
GET /fabric-intents/{fabric-intent-id}/configuration/vlans..........................................................................................41
Chapter 7: Edge-leaf..................................................................................................................... 43
GET /fabrics-intents/{fabric-intent-id}/edge/connections......................................................................................... 43
POST /fabrics-intents/{fabric-intent-id}/edge/connections...................................................................................... 45
GET /fabrics-intents/{fabric-intent-id}/edge/connections/{id}.................................................................................47
PUT /fabrics-intents/{fabric-intent-id}/edge/connections/{id}................................................................................ 48
DELETE /fabrics-intents/{fabric-intent-id}/edge/connections/{id}..........................................................................50
Chapter 8: Events......................................................................................................................... 52
GET /events........................................................................................................................................................................ 52
Contents
Contents 3