Edge Impulse Admin API
The Admin API from Edge Impulse — 49 operation(s) for admin.
Edge Impulse Admin API is one of 34 APIs that Edge Impulse publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Admin. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 72 operations across 49 paths, and defines 97 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against a single base URL, https://studio.edgeimpulse.com/v1.
72 operations
49 paths
97 schemas
13 DELETE35 GET19 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Edge Impulse Admin API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as x-api-key (ApiKeyAuthentication).
An API key is passed in the cookie as jwt (JWTAuthentication).
An API key is passed in the header as x-jwt-token (JWTHttpHeaderAuthentication).
By default, every request must be authenticated.
Paths & Operations 72
Across 49 paths, the API surfaces 72 operations — 13 DELETE, 35 GET, 19 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
Admin 72
GET
/api/admin/metrics
Get global metrics
GET
/api/admin/metrics/reports
Get global metrics reports
POST
/api/admin/metrics/reports
Create a new global metrics report
GET
/api/admin/metrics/reports/{reportId}
Get global metrics report
DELETE
/api/admin/metrics/reports/{reportId}
Delete global metrics report
GET
/api/admin/metrics/reports/{reportId}/download
Download global metrics report
GET
/api/admin/infra/migrations
Get data migrations
GET
/api/admin/infra/migrations/{migrationId}
Get data migration
POST
/api/admin/infra/migrations/{migrationId}
Run or pause a data migration
GET
/api/admin/infra/disallowedEmailDomains
Get the list of disallowed email domains
PUT
/api/admin/infra/disallowedEmailDomains
Add a disallowed email domain
DELETE
/api/admin/infra/disallowedEmailDomains/{domainName}
Delete disallowed email domain
GET
/api/admin/infra/featureFlags
Get all feature flags
PUT
/api/admin/infra/featureFlags/{featureId}
Set a feature flag ON
DELETE
/api/admin/infra/featureFlags/{featureId}
Set a feature flag OFF
GET
/api/admin/infra/config
Get all studio config
POST
/api/admin/infra/config/{configKey}
Update studio config
DELETE
/api/admin/infra/config/{configKey}
Delete a studio config item
GET
/api/admin/users
Get all users
GET
/api/admin/users/{userId}
Get user
POST
/api/admin/users/{userId}
Update user
DELETE
/api/admin/users/{userId}
Delete a user
GET
/api/admin/users/{userId}/metrics
Get user metrics
POST
/api/admin/users/{userId}/permissions
Update user permissions
GET
/api/admin/users/{userId}/jobs
Get user jobs
POST
/api/admin/trials
Create user enterprise trial
GET
/api/admin/trials/{enterpriseTrialId}
Get enterprise trial
PUT
/api/admin/trials/{enterpriseTrialId}
Update enterprise trial
DELETE
/api/admin/trials/{enterpriseTrialId}
Delete enterprise trial
POST
/api/admin/trials/{enterpriseTrialId}/upgrade
Upgrade enterprise trial to a full enterprise account
GET
/api/admin/projects
Get all projects
POST
/api/admin/projects
Create a new project
GET
/api/admin/projects/{projectId}
Get project
POST
/api/admin/projects/{projectId}
Update project
DELETE
/api/admin/projects/{projectId}
Delete a project
POST
/api/admin/projects/{projectId}/members
Add user to a project
DELETE
/api/admin/projects/{projectId}/members/{userId}
Remove user from a project
GET
/api/admin/projects/{projectId}/jobs
Get project jobs
GET
/api/admin/organizations
Get all organizations
POST
/api/admin/organizations
Create a new organization
GET
/api/admin/organizations/{organizationId}
Organization information
POST
/api/admin/organizations/{organizationId}
Update organization
DELETE
/api/admin/organizations/{organizationId}
Delete an organization
POST
/api/admin/organizations/{organizationId}/restore
Restore an organization
GET
/api/admin/organizations/{organizationId}/usage/computeTime
Get organization compute time usage
GET
/api/admin/organizations/{organizationId}/usage/reports
Get all usage reports
POST
/api/admin/organizations/{organizationId}/usage/reports
Creates a new usage report
GET
/api/admin/organizations/{organizationId}/usage/reports/{reportId}
Get usage report
DELETE
/api/admin/organizations/{organizationId}/usage/reports/{reportId}
Delete usage report
GET
/api/admin/organizations/{organizationId}/usage/reports/{reportId}/download
Download usage report
POST
/api/admin/organizations/{organizationId}/members
Add user to an organization
DELETE
/api/admin/organizations/{organizationId}/members/{userId}
Remove user from an organization
POST
/api/admin/organizations/{organizationId}/projects
Create a new organization project
GET
/api/admin/organizations/{organizationId}/exports
Get all organization data exports
POST
/api/admin/organizations/{organizationId}/exports
Create a new organization data export
GET
/api/admin/organizations/{organizationId}/exports/{exportId}
Get organization data export
DELETE
/api/admin/organizations/{organizationId}/exports/{exportId}
Delete organization data export
PUT
/api/admin/organizations/{organizationId}/exports/{exportId}
Update organization data export
GET
/api/admin/organizations/{organizationId}/jobs
Get organization jobs
GET
/api/admin/sso
Get SSO settings
GET
/api/admin/sso/{domainName}
Get SSO settings for a domain
PUT
/api/admin/sso/{domainName}
Add or update SSO settings for a domain
DELETE
/api/admin/sso/{domainName}
Delete SSO settings for a domain
GET
/api/admin/jobs/{jobId}/details
Get job execution details
GET
/api/admin/jobs/{jobId}/logs
Get job logs
GET
/api/admin/jobs/{jobId}/metrics
Get job usage metrics
GET
/api/admin/emails/{email}/verification-code
Get enterprise trial email verification code
GET
/api/admin/find-userdeprecated
Find a user
GET
/api/admin/users-idsdeprecated
Get all user IDs
GET
/api/admin/users-ids/activedeprecated
Get all user IDs (active last 30 days)
POST
/api/admin/projects/{projectId}/adddeprecated
Add current user to a project
POST
/api/admin/projects/{projectId}/removedeprecated
Remove current user from a project
Schemas 97
The contract defines 97 schemas that model the data the API accepts and returns. The most detailed are UpdateProjectRequest (43 properties), Project (29 properties), DailyMetricsRecord (20 properties), User (18 properties). Each schema is shown below with its type and property counts.
EntitlementLimits
object
5 properties
JobLogsResponse
AdminGetSSODomainIdPsResponse
Report
object
9 properties
7 required
OrganizationDataExport
object
9 properties
6 required
ListJobsResponse
AdminGetTrialResponse
JobState
object
4 properties
3 required
Feature
string
Known feature identifiers.
ProjectCollaborator
JobDetails
CreateOrganizationResponse
JobStep
object
5 properties
2 required
ApplicationBudget
object
Specifies limits for your specific application, as available RAM and ROM for the model's operation and the maximum allowed latency.
3 properties
AdminAddProjectUserRequest
TimeSeriesDataPoint
object
2 properties
2 required
ModelEngineShortEnum
string
FindUserResponse
AdminCreateOrganizationRequest
object
2 properties
1 required
AdminGetUserMetricsResponse
ProjectInfoResponse
Device
object
12 properties
10 required
KerasModelVariantEnum
string
AdminUpdateUserRequest
object
Only fields set in this object will be updated.
6 properties
AdminCreateProjectRequest
object
4 properties
1 required
StartJobResponse
AdminGetOrganizationComputeTimeUsageResponse
EnterpriseTrial
object
9 properties
8 required
JobStateExecutionDetails
object
1 property
ProjectDataSummary
object
3 properties
3 required
AdminToggleDataMigrationRequest
object
2 properties
2 required
MemorySpec
object
Describes performance characteristics of a particular memory type
2 properties
Permission
string
AdminUpdateOrganizationDataExportRequest
object
2 properties
OrganizationMemberRole
string
Job
object
12 properties
5 required
AdminGetDisallowedEmailDomainsResponse
JobMetricsResponse
AdminGetUserResponse
StartEnterpriseTrialRequest
object
12 properties
TrialNotes
string
Notes about the trial. Free form text. This field is ignored if the trial is requested by a non-admin user.
AdminOrganizationInfoResponse
User
object
18 properties
9 required
DailyMetricsRecord
object
20 properties
18 required
AdminGetUsersResponse
EntityCreatedResponse
TrialExpirationDate
string
Expiration date of the trial. The trial will be set as expired after this date. There will be a grace period of 30 days after a trial expires before fully dele…
UserExperiment
object
5 properties
4 required
GetOrganizationDataExportsResponse
AdminUpdateOrganizationRequest
object
Only fields set in this object will be updated.
9 properties
ProjectVisibility
string
The visibility of the project, either public or private. Public projects can be viewed by anyone on the internet and edited by collaborators. Private projects…
TargetProcessor
object
8 properties
AdminGetOrganizationsResponse
LatencyDevice
object
8 properties
8 required
GetStudioConfigResponse
JobFailureDetails
object
3 properties
UserTierEnum
string
The user account tier.
StaffInfo
object
3 properties
2 required
TargetConstraintsDevice
object
4 properties
ProjectType
string
AdminCreateOrganizationDataExportRequest
object
2 properties
1 required
GetOrganizationDataExportResponse
AdminGetReportsResponse
JobDetailsResponse
AdminGetUserIdsResponse
GenericApiResponse
object
2 properties
1 required
GetFeatureFlagsResponse
CreateProjectResponse
OrganizationComputeTimeUsage
object
3 properties
AdminApiUser
AdminAddUserRequest
object
1 property
AdminGetDataMigrationResponse
AdminUpdateConfigRequest
object
1 property
1 required
TargetConstraints
object
3 properties
2 required
AdminApiProject
object
11 properties
3 required
AdminAddOrganizationUserRequest
AdminAddOrUpdateSSODomainIdPsRequest
object
1 property
1 required
ResourceRange
object
Describes range of expected availability for an arbitrary resource
2 properties
GetEmailVerificationCodeResponse
JobParentTypeEnum
string
Project
object
29 properties
17 required
DevelopmentKeys
object
2 properties
AdminUpdateTrialRequest
object
2 properties
AdminGetSSOSettingsResponse
ProjectTierEnum
string
The project tier. This is "enterprise" for all organization projects, or the user tier for all user projects.
AdminGetReportResponse
Migration
object
3 properties
2 required
UpdateProjectRequest
object
Only fields set in this object will be updated.
43 properties
AdminListProjectsResponse
UserOrganization
object
15 properties
13 required
AdminGetMetricsResponse
AdminListProjects
object
2 properties
2 required
AdminAddDisallowedEmailDomainRequest
object
1 property
1 required
AdminStartEnterpriseTrialRequest
AdminUpdateUserPermissionsRequest
object
1 property
1 required
TargetMemory
object
RAM and ROM specifications of target
2 properties
AdminGetDataMigrationsResponse
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Edge Impulse 12
Other APIs Edge Impulse publishes across the network.
Edge Impulse Auth API
Edge Impulse Canary API
Edge Impulse CDN API
Edge Impulse Classify API
Edge Impulse Deployment API
Edge Impulse Devices API
Edge Impulse DSP API
Edge Impulse EmailVerification API
Edge Impulse Export API
Edge Impulse FeatureFlags API
Edge Impulse Health API
Edge Impulse Impulse API
#Admin