Getting Started

This documentation outlines the steps necessary to deploy and set up the Ed-Fi ODS / API Admin API. The Admin API provides an API interface to perform common administrative tasks for an instance of an Ed-Fi ODS / API.

Audience

This documentation is for administrators and DevOps personnel who will be installing the Admin API.

Contents

Admin API 2.0 - Installation and Setup for ODS / API 7.0

• Installation for Admin API 2.0
• First-Time Configuration for Admin API 2.x

Admin API 1.3 - Installation and Setup for ODS / API 3.4 - 6.1

• Installation for Admin API 1.0
• First-Time Configuration for Admin API 1.x

Usage

• Endpoints in Admin API 2.x
• Endpoints - Admin API 1.3
• Securing Admin API