Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zededa ProfileDeploymentService API

The ProfileDeploymentService API from Zededa — 4 operation(s) for profiledeploymentservice.

Zededa ProfileDeploymentService API is one of 35 APIs that Zededa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ProfileDeploymentService. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 4 paths, and defines 18 schemas. It is described by OpenAPI 2.0, at version 1.0.

Requests are made against the base URL https://zedcontrol.zededa.net/api.

7 operations 4 paths 18 schemas 1 DELETE4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
Base URL
https://zedcontrol.zededa.net/api
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Zededa ProfileDeploymentService API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (BearerToken). By default, every request must be authenticated.

  • BearerToken — Bearer token for user session

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

ProfileDeploymentService 7
GET
/v1/profiledeployments
Query profile deployments
ProfileDeploymentService_QueryProfileDeployments 8 params → 200400401403500504default
POST
/v1/profiledeployments
Create profile deployment
ProfileDeploymentService_CreateProfileDeployment 2 params → 200400401403409500504default
GET
/v1/profiledeployments/id/{id}
Get profile deployment
ProfileDeploymentService_GetProfileDeployment 2 params → 200401403404500504default
DELETE
/v1/profiledeployments/id/{id}
Delete profile deployment
ProfileDeploymentService_DeleteProfileDeployment 2 params → 200401403404409500504default
PUT
/v1/profiledeployments/id/{id}
Update profile deployment
ProfileDeploymentService_UpdateProfileDeployment 3 params → 200401403404409500504default
GET
/v1/profiledeployments/id/{id}/resourcestatus
Query profile deployments resource status
ProfileDeploymentService_QueryProfileDeploymentResourceStatus 7 params → 200400401403500504default
GET
/v1/profiledeployments/name/{name}
Get profile deployment by name
ProfileDeploymentService_GetProfileDeploymentByName 2 params → 200401403404500504default

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are ZsrvResponse (15 properties), ProfileDeployment (8 properties), ProfileDeploymentResourceDetailedStatus (8 properties), Cursor (5 properties). Each schema is shown below with its type and property counts.

protobufAny
object
2 properties
ProfileDeploymentResourceObjectStatus
object
3 properties
ZcOpsType
string
Cursor
object
Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc.
5 properties
ZsrvResponse
object
15 properties
ObjectType
string
ProfileDeploymentResourceDetailedStatusResp
object
2 properties
ProfileDeploymentList
object
2 properties
ZsrvErrorCode
string
- zMsgErrorNone: common validation errors - IncompleteData: message had fields that weren't filled in - InvalidData: message contained the field that wasn't ex…
ProfileDeployment
object
Profile Deployment is a proto that should be used by user-agents to create/update deployments
8 properties 4 required
ZsrvError
object
3 properties
googlerpcStatus
object
3 properties
ProfileDeploymentResourceDetailedStatus
object
8 properties
ProfileDeploymentPerDeviceStatus
object
2 properties
RunState
string
- RUNSTATEONLINE: Entity Online - RUNSTATEHALTED: Entity Halted - RUNSTATEINIT: Entity Initializing - RUNSTATEREBOOTING: Entity Rebooting - RUNSTATEOFFLINE: En…
TargetAssetGroup
object
1 property
ZcOpsStatus
string
- OPSSTATUSPENDING: In rare cases, system may not start operation when it was requested. Client will be notified that operation is PENDING - OPSSTATUSONGOING:…
AppProfileInfo
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zededa-profiledeploymentservice-api-openapi.yml Raw ↑

Other APIs Zededa publishes across the network.

Zededa AppProfileService API
Zededa ArtifactManager API
Zededa AssetGroupService API
Zededa BulkJobOps API
Zededa CertificateEnrollmentProfileConfiguration API
Zededa CloudDiagnostics API
Zededa ClusterGroups API
Zededa ClusterStatus API
Zededa DatastoreConfiguration API
Zededa EdgeApplicationConfiguration API
Zededa EdgeApplicationInstanceConfiguration API
Zededa EdgeApplicationInstanceStatus API