Sign in
activations

post/activations/

Request body

namestring required
descriptionstring
is_enabledboolean
decision_environment_idinteger required
rulebook_idinteger required
extra_varstring nullable
organization_idinteger nullable
restart_policy'always' | 'on-failure' | 'never'
  • always - always
  • on-failure - on-failure
  • never - never
awx_token_idinteger nullable
log_level'debug' | 'info' | 'error'
  • debug - debug
  • info - info
  • error - error
eda_credentialsinteger[] nullable
k8s_service_namestring nullable
source_mappingsstring

Mapping between sources and event streams

skip_audit_eventsboolean

Skip audit events for activation

Response

idinteger required
namestring required
descriptionstring
is_enabledboolean
status'starting' | 'running' | 'pending' | 'failed' | 'stopping' | 'stopped' | 'deleting' | 'completed' | 'unresponsive' | 'error' | 'workers offline'
  • starting - starting
  • running - running
  • pending - pending
  • failed - failed
  • stopping - stopping
  • stopped - stopped
  • deleting - deleting
  • completed - completed
  • unresponsive - unresponsive
  • error - error
  • workers offline - workers offline
git_hashstring
extra_varstring nullable
restart_policy'always' | 'on-failure' | 'never'
  • always - always
  • on-failure - on-failure
  • never - never
restart_countinteger
rulebook_namestring required

Name of the referenced rulebook

current_job_idstring nullable
rules_countinteger required
rules_fired_countinteger required
created_atstring date-time required
modified_atstring date-time required
restarted_atstring date-time nullable
status_messagestring nullable
awx_token_idinteger nullable required
log_level'debug' | 'info' | 'error'
  • debug - debug
  • info - info
  • error - error
k8s_service_namestring nullable

Service name of the activation

source_mappingsstring

Mapping between sources and event streams

skip_audit_eventsboolean

Skip audit events for activation

Changes

Changed in 8 of the 8 revisions of this API.225996

  • c04fc5f096922323See the full diff
    • ▲

      removed the required property eda_credentials/items/credential_type/allOf[CredentialTypeRef]/organization_id from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property instances/items/event_stream_id from the response with the 201 status

      response-required-property-removed

    • ●

      removed the request property event_streams (media type: application/json)

      request-property-removed

    • ●

      removed the request property event_streams (media type: application/x-www-form-urlencoded)

      request-property-removed

    • ●

      removed the request property event_streams (media type: multipart/form-data)

      request-property-removed

    • ○

      added the new optional request property skip_audit_events (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property skip_audit_events (media type: application/x-www-form-urlencoded)

      new-optional-request-property

    • ○

      added the new optional request property skip_audit_events (media type: multipart/form-data)

      new-optional-request-property

    • ○

      added the new optional request property source_mappings (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property source_mappings (media type: application/x-www-form-urlencoded)

      new-optional-request-property

    • ○

      added the new optional request property source_mappings (media type: multipart/form-data)

      new-optional-request-property

    • ○

      added the optional property event_streams/items/additional_data_headers to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property event_streams/items/event_stream_type to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property event_streams/items/test_mode to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property skip_audit_events to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property source_mappings to the response with the 201 status

      response-optional-property-added

    • ○

      added the required property event_streams/items/created_at to the response with the 201 status

      response-required-property-added

    • ○

      added the required property event_streams/items/eda_credential to the response with the 201 status

      response-required-property-added

    • ○

      added the required property event_streams/items/events_received to the response with the 201 status

      response-required-property-added

    • ○

      added the required property event_streams/items/last_event_received_at to the response with the 201 status

      response-required-property-added

    • ○

      added the required property event_streams/items/modified_at to the response with the 201 status

      response-required-property-added

    • ○

      added the required property event_streams/items/organization to the response with the 201 status

      response-required-property-added

    • ○

      added the required property event_streams/items/owner to the response with the 201 status

      response-required-property-added

    • ○

      added the required property event_streams/items/test_content to the response with the 201 status

      response-required-property-added

    • ○

      added the required property event_streams/items/test_content_type to the response with the 201 status

      response-required-property-added

    • ○

      added the required property event_streams/items/test_error_message to the response with the 201 status

      response-required-property-added

    • ○

      added the required property event_streams/items/test_headers to the response with the 201 status

      response-required-property-added

    • ○

      added the required property event_streams/items/url to the response with the 201 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • feeac1db5ade135See the full diff
    • ▲

      the extra_var response's property type/format changed from / to string/ for status 201

      response-property-type-changed

    • ●

      removed the request property extra_var_id (media type: application/json)

      request-property-removed

    • ●

      removed the request property extra_var_id (media type: application/x-www-form-urlencoded)

      request-property-removed

    • ●

      removed the request property extra_var_id (media type: multipart/form-data)

      request-property-removed

    • ○

      added the new optional request property extra_var (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property extra_var (media type: application/x-www-form-urlencoded)

      new-optional-request-property

    • ○

      added the new optional request property extra_var (media type: multipart/form-data)

      new-optional-request-property

    • ○

      removed ExtraVarRef from the extra_var response property allOf list for the response status 201

      response-property-all-of-removed

    • ○

      added the required property instances/items/queue_name to the response with the 201 status

      response-required-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • cbf68ddd97601233See the full diff
    • ▲

      the response property instances/items/activation_id became nullable for the status 201

      response-property-became-nullable

    • ●

      added the new workers offline enum value to the instances/items/status response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new workers offline enum value to the status response property for the response status 201

      response-property-enum-value-added

    • ○

      the endpoint scheme security EDAJWTAuthentication was added to the API

      api-security-added

    • ○

      the endpoint scheme security jwtAuth was added to the API

      api-security-added

    • ○

      added the new optional request property awx_token_id (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property awx_token_id (media type: application/x-www-form-urlencoded)

      new-optional-request-property

    • ○

      added the new optional request property awx_token_id (media type: multipart/form-data)

      new-optional-request-property

    • ○

      added the new optional request property eda_credentials (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property eda_credentials (media type: application/x-www-form-urlencoded)

      new-optional-request-property

    • ○

      added the new optional request property eda_credentials (media type: multipart/form-data)

      new-optional-request-property

    • ○

      added the new optional request property event_streams (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property event_streams (media type: application/x-www-form-urlencoded)

      new-optional-request-property

    • ○

      added the new optional request property event_streams (media type: multipart/form-data)

      new-optional-request-property

    • ○

      added the new optional request property k8s_service_name (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property k8s_service_name (media type: application/x-www-form-urlencoded)

      new-optional-request-property

    • ○

      added the new optional request property k8s_service_name (media type: multipart/form-data)

      new-optional-request-property

    • ○

      added the new optional request property log_level (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property log_level (media type: application/x-www-form-urlencoded)

      new-optional-request-property

    • ○

      added the new optional request property log_level (media type: multipart/form-data)

      new-optional-request-property

    • ○

      added the new optional request property organization_id (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property organization_id (media type: application/x-www-form-urlencoded)

      new-optional-request-property

    • ○

      added the new optional request property organization_id (media type: multipart/form-data)

      new-optional-request-property

    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the optional property eda_credentials to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property event_streams to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property k8s_service_name to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property log_level to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property project/allOf[ProjectRef]/scm_type to the response with the 201 status

      response-optional-property-added

    • ○

      added the required property awx_token_id to the response with the 201 status

      response-required-property-added

    • ○

      added the required property decision_environment/allOf[DecisionEnvironmentRef]/organization_id to the response with the 201 status

      response-required-property-added

    • ○

      added the required property instances/items/event_stream_id to the response with the 201 status

      response-required-property-added

    • ○

      added the required property instances/items/organization_id to the response with the 201 status

      response-required-property-added

    • ○

      added the required property organization to the response with the 201 status

      response-required-property-added

    • ○

      added the required property project/allOf[ProjectRef]/organization_id to the response with the 201 status

      response-required-property-added

    • ○

      added the required property rulebook/allOf[RulebookRef]/organization_id to the response with the 201 status

      response-required-property-added

    This revision also has 24 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • cf4bda9538d3566See the full diff
    • ▲

      the response property rulebook became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property rulebook became optional for the status 201

      response-property-became-optional

    • ▲

      the rulebook response's property type/format changed from object/ to / for status 201

      response-property-type-changed

    • ▲

      removed the required property rulebook/id from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property rulebook/name from the response with the 201 status

      response-required-property-removed

    • ●

      removed the request property project_id (media type: application/json)

      request-property-removed

    • ●

      removed the request property project_id (media type: application/x-www-form-urlencoded)

      request-property-removed

    • ●

      removed the request property project_id (media type: multipart/form-data)

      request-property-removed

    • ●

      removed the optional property rulebook/description from the response with the 201 status

      response-optional-property-removed

    • ●

      added the new error enum value to the instances/items/status response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new error enum value to the status response property for the response status 201

      response-property-enum-value-added

    • ○

      added the optional property current_job_id to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property git_hash to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property instances/items/git_hash to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property instances/items/status_message to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property status_message to the response with the 201 status

      response-optional-property-added

    • ○

      added RulebookRef to the rulebook response property allOf list for the response status 201

      response-property-all-of-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 011f9cfbad0912See the full diff
    • ▲

      the response property status became optional for the status 201

      response-property-became-optional

    • ●

      added the new deleting enum value to the instances/items/status response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new deleting enum value to the status response property for the response status 201

      response-property-enum-value-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c84b4813cab142See the full diff
    • ●

      added the new stopping enum value to the instances/items/status response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new stopping enum value to the status response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new unresponsive enum value to the instances/items/status response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new unresponsive enum value to the status response property for the response status 201

      response-property-enum-value-added

    • ○

      the endpoint scheme security cookieAuth was added to the API

      api-security-added

    • ○

      added the optional property restarted_at to the response with the 201 status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f84d9240fdf2710See the full diff
    • ▲

      the request property decision_environment_id became not nullable (media type: application/json)

      request-property-became-not-nullable

    • ▲

      the request property decision_environment_id became not nullable (media type: application/x-www-form-urlencoded)

      request-property-became-not-nullable

    • ▲

      the request property decision_environment_id became not nullable (media type: multipart/form-data)

      request-property-became-not-nullable

    • ▲

      removed the required property decision_environment_id from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property extra_var_id from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property project_id from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property rulebook_id from the response with the 201 status

      response-required-property-removed

    • ○

      the endpoint scheme security cookieAuth was removed from the API

      api-security-removed

    • ○

      added the optional property decision_environment to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property extra_var to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property project to the response with the 201 status

      response-optional-property-added

    • ○

      added the required property instances to the response with the 201 status

      response-required-property-added

    • ○

      added the required property rulebook to the response with the 201 status

      response-required-property-added

    • ○

      added the required property rules_count to the response with the 201 status

      response-required-property-added

    • ○

      added the required property rules_fired_count to the response with the 201 status

      response-required-property-added

    • ○

      added the required property status to the response with the 201 status

      response-required-property-added

    • ○

      the response required property rulebook_name became not read-only for the status 201

      response-required-property-became-not-read-only

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 62d33b79083453917See the full diff
    • ▲

      removed the required property awx_token_id from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property instances from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property organization from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property rules_count from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property rules_fired_count from the response with the 201 status

      response-required-property-removed

    • ●

      removed the request property awx_token_id (media type: application/json)

      request-property-removed

    • ●

      removed the request property awx_token_id (media type: application/x-www-form-urlencoded)

      request-property-removed

    • ●

      removed the request property awx_token_id (media type: multipart/form-data)

      request-property-removed

    • ●

      removed the request property eda_credentials (media type: application/json)

      request-property-removed

    • ●

      removed the request property eda_credentials (media type: application/x-www-form-urlencoded)

      request-property-removed

    • ●

      removed the request property eda_credentials (media type: multipart/form-data)

      request-property-removed

    • ●

      removed the request property extra_var (media type: application/json)

      request-property-removed

    • ●

      removed the request property extra_var (media type: application/x-www-form-urlencoded)

      request-property-removed

    • ●

      removed the request property extra_var (media type: multipart/form-data)

      request-property-removed

    • ●

      removed the request property k8s_service_name (media type: application/json)

      request-property-removed

    • ●

      removed the request property k8s_service_name (media type: application/x-www-form-urlencoded)

      request-property-removed

    • ●

      removed the request property k8s_service_name (media type: multipart/form-data)

      request-property-removed

    • ●

      removed the request property log_level (media type: application/json)

      request-property-removed

    • ●

      removed the request property log_level (media type: application/x-www-form-urlencoded)

      request-property-removed

    • ●

      removed the request property log_level (media type: multipart/form-data)

      request-property-removed

    • ●

      removed the request property organization_id (media type: application/json)

      request-property-removed

    • ●

      removed the request property organization_id (media type: application/x-www-form-urlencoded)

      request-property-removed

    • ●

      removed the request property organization_id (media type: multipart/form-data)

      request-property-removed

    • ●

      removed the request property skip_audit_events (media type: application/json)

      request-property-removed

    • ●

      removed the request property skip_audit_events (media type: application/x-www-form-urlencoded)

      request-property-removed

    • ●

      removed the request property skip_audit_events (media type: multipart/form-data)

      request-property-removed

    • ●

      removed the request property source_mappings (media type: application/json)

      request-property-removed

    • ●

      removed the request property source_mappings (media type: application/x-www-form-urlencoded)

      request-property-removed

    • ●

      removed the request property source_mappings (media type: multipart/form-data)

      request-property-removed

    • ●

      removed the optional property current_job_id from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property decision_environment from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property eda_credentials from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property event_streams from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property extra_var from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property git_hash from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property k8s_service_name from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property log_level from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property project from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property restarted_at from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property rulebook from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property skip_audit_events from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property source_mappings from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property status from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property status_message from the response with the 201 status

      response-optional-property-removed

    • ○

      the endpoint scheme security EDAJWTAuthentication was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security jwtAuth was removed from the API

      api-security-removed

    • ○

      added the new optional request property extra_var_id (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property extra_var_id (media type: application/x-www-form-urlencoded)

      new-optional-request-property

    • ○

      added the new optional request property extra_var_id (media type: multipart/form-data)

      new-optional-request-property

    • ○

      added the new optional request property project_id (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property project_id (media type: application/x-www-form-urlencoded)

      new-optional-request-property

    • ○

      added the new optional request property project_id (media type: multipart/form-data)

      new-optional-request-property

    • ○

      the request property decision_environment_id became nullable (media type: application/json)

      request-property-became-nullable

    • ○

      the request property decision_environment_id became nullable (media type: application/x-www-form-urlencoded)

      request-property-became-nullable

    • ○

      the request property decision_environment_id became nullable (media type: multipart/form-data)

      request-property-became-nullable

    • ○

      removed the non-success response with the status 400

      response-non-success-status-removed

    • ○

      added the required property decision_environment_id to the response with the 201 status

      response-required-property-added

    • ○

      added the required property extra_var_id to the response with the 201 status

      response-required-property-added

    • ○

      added the required property project_id to the response with the 201 status

      response-required-property-added

    • ○

      added the required property rulebook_id to the response with the 201 status

      response-required-property-added

    • ○

      the response required property rulebook_name became read-only for the status 201

      response-required-property-became-read-only

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog