Endpoints in Admin API 2.x

Admin API endpoints documentation is found on GitHub and available in links below:

Version	GitHub URL
Admin API 2.2.0	https://github.com/Ed-Fi-Alliance-OSS/AdminAPI-2.x/tree/main/docs/api-specifications

For the most accurate and detailed documentation of active endpoints in a version, configure and launch your application with SwaggerEnabled : true (this is not recommended in production). The documentation can be found at https://{mydomain}/swagger/v2/swagger.json and the UI found at https://{mydomain}/adminapi/swagger/index.html.

All functional endpoints require authentication to access. See Securing Admin API for details.

Common Responses

Response Code	Description	Valid for Verbs	Notes
200 SUCCESS	Request was successful	ALL
201 CREATED	Resource was created successfully	POST	Response will also include a `location` header which directs to the new resource
400 BAD REQUEST	Invalid request payload - See errors for details	POST, PUT
401 UNAUTHORIZED	Missing or invalid authentication token	ALL
403 FORBIDDEN	Authentication token is valid but resource is outside of authenticated scope	ALL
404 NOT FOUND	Resource with given `id` not found	ALL
500 INTERNAL SERVER ERROR	Unexpected error on the system - See error for details	ALL