Jump to Content
Guides
API Reference
v0.6
v0.7
v0.7.1
v0.8.0
v0.9.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v0.9.0
Guides
API Reference
/v1/protections/configure/validate
Search
JUMP TO
Prodvana API
prodvana.application.ApplicationManager
/v1/applications
get
/v1/applications/configure
post
/v1/applications/configure/validate
post
/v1/applications/{application}
get
/v1/applications/{application}/config
get
/v1/applications/{application}/insights
get
/v1/applications/{application}/insights/snooze
put
Get application metadata, useful for constructing edit workflows for metadata
get
/v1/applications/{application}/metadata
post
/v1/applications/{application}/metrics
get
/v1/{application}/delete
delete
prodvana.release_channel.ReleaseChannelManager
/v1/applications/{application}/release-channels
get
/v1/applications/{application}/release-channels/{releaseChannel}
get
/v1/release-channels/configure
post
/v1/release-channels/{releaseChannel}/delete
delete
prodvana.service.ServiceManager
/v1/applications/{application}/services
get
/v1/applications/{application}/services/{service}
get
/v1/applications/{application}/services/{service}/commits
get
/v1/applications/{application}/services/{service}/insights
get
/v1/applications/{application}/services/{service}/insights/snooze
put
/v1/applications/{application}/services/{service}/metadata
get
/v1/applications/{application}/services/{service}/metadata
post
/v1/applications/{application}/services/{service}/metrics
get
/v1/applications/{application}/services/{service}/release-channels
get
/v1/applications/{application}/services/{service}/release-channels/{releaseChannel}
get
/v1/{application}/services/configure
post
/v1/{application}/services/configure/validate
post
/v1/{application}/services/{service}/config
get
/v1/{application}/services/{service}/delete
delete
/v1/{application}/services/{service}/instances/{releaseChannel}/pushes
get
/v1/{application}/services/{service}/instances/{releaseChannel}/pushes/{creationTimestamp}
get
/v1/{application}/services/{service}/versions
get
prodvana.desired_state.DesiredStateManager
/v1/applications/{application}/services/{service}/desired_states
get
/v1/applications/{application}/services/{service}/last_converged
get
/v1/applications/{application}/services/{service}/latest_desired_state
get
/v1/desired_states
post
/v1/desired_states/approve_manual_condition
post
/v1/desired_states/promote_delivery
post
/v1/desired_states/validate
post
/v1/desired_states/{desiredStateId}
get
deprecated, use GetDesiredStateConvergenceEvents in conjunction with summary
get
/v1/desired_states/{desiredStateId}/events
get
/v1/desired_states/{desiredStateId}/summary
get
prodvana.workflow.WorkflowManager
/v1/applications/{application}/services/{service}/image
get
/v1/integrations
get
/v1/integrations/container-registry/create
post
/v1/integrations/container-registry/list
get
/v1/integrations/github/create
get
/v1/integrations/github/install
get
/v1/integrations/grafana
get
/v1/integrations/grafana/install
post
/v1/integrations/grafana/uninstall
delete
/v1/integrations/honeycomb
delete
/v1/integrations/honeycomb/environment
get
/v1/integrations/honeycomb/environment
post
/v1/integrations/honeycomb/environment/{name}
delete
/v1/integrations/honeycomb/environment/{name}
put
/v1/integrations/pagerduty/install
get
/v1/integrations/pagerduty/install-url
get
/v1/integrations/pagerduty/uninstall
delete
/v1/integrations/slack/install
get
/v1/integrations/slack/install-url
get
/v1/integrations/slack/uninstall
delete
/v1/integrations/{integrationId}
delete
/v1/integrations/{integrationId}/images
get
/v1/integrations/{integrationId}/program-defaults
get
prodvana.auth.ApiTokenManager
Create an api token tied to the organization. This api token is not tied to the user in anyway, e.g. if the user is deleted, the token will continue to have access to the organization. This token currently does not expire, so be very careful with storing them.
post
prodvana.auth.AuthManager
/v1/auth/get_auth_url
get
web auth flow TODO(naphat) we should make this only available to our UI app
get
/v1/auth/refresh_auth_token
post
prodvana.auth.AuthSessionManager
check if user is authenticated and token is still valid
get
prodvana.environment.EnvironmentManager
/v1/clusters/configure
post
/v1/clusters/configure/validate
post
/v1/clusters/get_auth
get
/v1/clusters/get_status
get
/v1/clusters/link
post
/v1/clusters/list
get
/v1/clusters/remove
post
/v1/clusters/{runtimeName}/config
post
/v1/clusters/{runtimeName}/detect-config
post
prodvana.managed_resource.ResourceManager
/v1/managed_resources
get
/v1/managed_resources/k8s/configure
post
/v1/managed_resources/{managedResource}
get
/v1/managed_resources/{managedResource}/archive/archive/archive/archive
get
/v1/managed_resources/{managedResource}/delete
delete
prodvana.organization.OrganizationManager
/v1/organization
get
/v1/organization/insights
get
/v1/organization/insights/snooze
put
Get org metadata, useful for constructing edit workflows for metadata
get
/v1/organization/metadata
post
/v1/organization/metrics
get
prodvana.protection.ProtectionManager
/v1/protections
get
/v1/protections/configure
post
/v1/protections/configure/validate
post
/v1/protections/{protection}
get
/v1/protections/{protection}/config
get
prodvana.settings.organization.UsersSettingsManager
/v1/settings/organization/roles
get
/v1/settings/organization/users
get
/v1/settings/organization/users/{userId}
get
/v1/settings/organization/users/{userId}/roles
post
/v1/protections/configure/validate
post
https://example.com/v1/protections/configure/validate
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!
