Global Navigation

  • Products
  • Overview
  • Getting Started
  • Guides
  • Resources
  • Console

Table of Contents

  • Introduction
    • App Builder Overview
    • What is App Builder
    • Business Case
    • FAQ
    • Community
  • Quick Start
    • App Builder Getting Started
      • Setting Up
      • Creating your First App
      • Publishing Your App
      • Troubleshooting
    • Runtime Getting Started
      • Overview
      • Activations
      • Deploy
      • Entities
      • How Runtime Works
      • Resources
      • Setup
      • Understanding Runtime
  • Develop
    • References
    • App Builder Guides
      • Architecture Overview
        • App Hooks
        • Introduction to React Spectrum
        • Using SDKs
      • Application State
      • Application Logging
        • Azure Log Analytics
        • New Relic
        • Splunk Cloud
        • Splunk Enterprise
      • Configuration
        • Webpack Configuration
      • Deployment
        • CI/CD for App Builder Apps
        • Credential Rotation
        • Setting Response Headers
      • Development
      • Distribution
      • Events
        • Webhooks
      • Exc App
        • Interfaces
          • Modules
          • Page ObjectWithHref
          • Page ObjectWithPath
          • Page PageAPI
          • Page PageAPIProperties
          • Runtime
          • TopBar Callback
          • TopBar CustomFeedbackConfig
          • TopBar CustomSearchConfig
          • TopBar ExternalFeedbackConfig
          • TopBar HelpCenterFeedbackConfig
          • TopBar Solution
          • TopBar TopBarAPI
          • TopBar TopBarAPIProperties
          • User UserAPI
          • User UserInfo
        • Migrate App to Exp Cloud SPA
        • Modules
          • Page
          • TopBar
          • User
      • Extensions
        • Extension Migration Guide
      • Optimization
      • Security
        • Understanding Authentication
      • Telemetry
    • Runtime Guides
      • Contribution Guide
      • Asynchronous Calls
      • Creating Actions
      • Creating REST APIs
      • CI/CD Pipeline
      • Debugging
      • Logging & Monitoring
      • Reference Docs
        • API Reference
        • CLI Usage
        • Configuring Proxy
        • Environment Variables
        • Feeds
        • Multiple Regions
        • Packages
        • Prepackages
        • Runtimes
        • Sequences & Compositions
        • Triggers & Rules
        • WSK Usage
      • Security General
      • Securing Web Actions
      • System Settings
      • Throughput Tuning
      • Tools
        • CLI Install
      • Troubleshooting
      • Using Packages
      • Using Runtime
    • Contribution Guide
  • Learning
    • Asset Compute Worker PS API
      • Requirements
      • Lesson 1: Create an app from Asset Compute template
      • Lesson 2: Configure the app
      • Lesson 3: Develop worker calling Photoshop API
      • Lesson 4: Integrate worker in AEMaaCS
      • Well done
    • Barcode Reader
      • Requirements
      • Lesson 1: Bootstrap a Headless App
      • Lesson 2: Writing a Serverless Action
      • Lesson 3: Unit and E2E Tests
      • Well done
    • Blog Articles
      • Blog Articles
    • CI/CD
      • Requirements
      • Lesson 1: Setup CI/CD
      • Lesson 2: Monitoring CI/CD
      • Lesson 3: Custom CI/CD workflow
      • Well done
    • Cron Jobs
      • Requirements
      • Lesson 1: Bootstrap a Headless App
      • Lesson 2: Set up Alarm Feed with Trigger and Rule
      • Lesson 3: Types of Alarm Feed
      • Well done
    • Custom Asset Compute Worker
      • Requirements
      • How AEM as Cloud assets works
      • Architecture of our worker
      • Configure services
      • Local environment setup
      • Implement the worker
      • Test the worker
      • Setup AEM to use the worker
      • Well Done
    • Customer Dashboard
      • Requirements
      • Lesson 1: Create a New App Builder App from Campaign Standard Template
      • Lesson 2: Explore the App Builder App
      • Lesson 3: Run the App Builder App Locally
      • Lesson 4: List All Customer Profiles on the UI
      • Lesson 5: Add Personalized Promotion Emails Triggering
      • Well Done
    • Debugging
      • Requirements
      • Lesson 1: Getting familiar with Debugger
      • Lesson 2: Debugging Application Code
      • Lesson 3: Managing Application Logs
      • Well Done
    • Event Driven
      • Requirements
      • Lesson 1: Create a New App Builder App from Template
      • Lesson 2: Register the App as Event Provider
      • Lesson 3: Fire an Event
      • Lesson 4: Consume Events
      • Well Done
    • Events Runtime
      • Requirements
      • Lesson 1: Step by Step Guide
      • Lesson 2: Verify the result
      • Well done
    • Journaling Events
      • Requirements
      • Lesson 1: Create an Event Provider using App Builder
      • Lesson 2: Create the Event Consumer using Journaling API
      • Lesson 3: End to end test
      • Well done
    • Sample Apps
      • Code Snippets
        • Caching HTTP responses
        • App Builder Files SDK
        • App Builder State SDK
        • I/O Events handler
        • Real-time data from Adobe Analytics API 1.4
    • Spectrum Introduction
      • Lesson 1: What is Spectrum ?
      • Lesson 2: Using Spectrum CSS
      • Lesson 3: Using React Spectrum
      • Lesson 4: Using React Spectrum in App Builder
      • Well done
    • Todo App
      • Requirements
      • Lesson 1: Create a New App Builder App with the React Spectrum template
      • Lesson 2: Setup Runtime actions
      • Lesson 3: Setup the CreateTodoList component
      • Lesson 4: Setup the Todo component
      • Lesson 5: Setup the TodoList component
      • Lesson 6: Bringing the pieces together to build the App
      • Well done
    • Videos
      • Overview
        • Introducing App Builder
        • Getting Started
        • Architecture
        • A Full Security Overview
        • User Journey
      • Exploring
        • Projects and Workspaces
        • React Spectrum
        • Custom Events
        • CI/CD
        • Debugging
        • Learning Resources
        • Dashboard Case Study
        • ODE Case Study
        • Deep Dive Use Cases
        • Live Wired Sneak
        • Softcrylic Partner Showcase
      • Developers Live
        • App Builder Deep Dive
        • Asset Compute Service Extensibility
        • Extend Adobe Experience Cloud
  1. Products
  2. Overview
  3. Guides
  4. Develop
  5. Runtime Guides
  6. Reference Docs
  7. API Reference

Adobe I/O Runtime API Reference

API endpoints

Adobe I/O Runtime supports the following API endpoints for interacting programmatically with the service.

Notes:

  1. Unless otherwise noted, all parameters are required.
  2. For all the API calls on this page, the base URL is:
    https://api.adobe.io/

GET /runtime/admin/namespaces/orgId/intId

Returns the details of the namespace associated with the specified organization and integration.

Parameters:

Name
Description
orgId (string: path)
Organization ID
intId (string: path)
Integration ID
Authorization (string: header)
Authorization token in format: Bearer {token}
X-Api-Key (string: header)
Api key

Responses:

Response content type: application/json

Code
Description
200
Successful operationExample value:
{ "name": "string", "auth": "string" } Model: NamespaceDTO { description: Namespace Details name string Namespace name auth string Auth associated with Namespace }

POST /runtime/admin/namespaces/orgId/intId

Creates a new namespace and returns the details of the newly created namespace. If namespace already exists it returns the details of the namespace.

Parameters:

Name
Description
orgId (string: path)
Organization ID
intId (string: path)
Integration ID
Authorization (string: header)
Authorization token in format: Bearer {token}
X-Api-Key (string: header)
Api key

Responses:

Response content type: application/json

Code
Description
200
Successful operation Example value:
{ "name": "string", "auth": "string" } Model: NamespaceDTO { description: Namespace Details name string Namespace name auth string Auth associated with Namespace }

DELETE /runtime/admin/namespaces/orgId/intId

Deletes the namespace associated with the specified organization and integration.

Parameters:

Name
Description
orgId (string: path)
Organization ID
intId (string: path)
Integration ID
Authorization (string: header)
Authorization token in format: Bearer {token}
X-Api-Key (string: header)
Api key

Responses:

Response content type: application/json

Code
Description
default
Successful operation

GET /runtime/namespaces/orgId/intId/actions

Returns the list of actions associated with the specified organization and integration.

Parameters:

Name
Description
orgId (string: path)
Organization ID
intId (string: path)
Integration ID
Authorization (string: header)
Authorization token in format: Bearer {token}
X-Api-Key (string: header)
Api key

Responses:

Response content type: application/json

Code
Description
200
Successful operation Example value:
[ { "name": "string", "code": "string", "namespace": "string", "version": "string", "params": [ { "key": "string", "value": {} } ], "annotations": [ { "key": "string", "value": {} } ], "limits": { "timeout": "string", "memory": "string", "logs": "string" }, "exec": { "kind": "string", "binary": false, "components": [ "string" ] }, "url": "string" } ] Model: [ActionDTO { description: OpenWhisk Action name string Action name code string Action code namespace string Action namespace version string Action version params [Action params KeyValuePairDTO { description: OpenWhisk Action param key string Param Name value { description: Param value } }] annotations [Action annotations KeyValuePairDTO { description: OpenWhisk Action param key string Param Name value { description: Param value } }] limits LimitsDTO { description: OpenWhisk Action Limits timeout string Action timeout memory string Action memory limit logs string Action logs } exec ExecDTO { description: OpenWhisk Action exec details kind string Action kind binary boolean default: false Is action binary components [ Action components in case of sequence string] } url string Action url }]

POST /runtime/namespaces/orgId/intId/actions

Creates a new action.

Parameters:

Name
Description
orgId (string: path)
Organization ID
intId (string: path)
Integration ID
Authorization (string: header)
Authorization token in format: Bearer token
X-Api-Key (string: header)
Api key
body (body)
Action form. Example value:
{ "name": "string", "code": "string", "namespace": "string", "version": "string", "params": [ { "key": "string", "value": {} } ], "annotations": [ { "key": "string", "value": {} } ], "limits": { "timeout": "string", "memory": "string", "logs": "string" }, "exec": { "kind": "string", "binary": false, "components": [ "string" ] }, "url": "string" }Parameter content type: application/json Model: [ActionDTO { description: OpenWhisk Action name string Action name code string Action code namespace string Action namespace version string Action version params [Action params KeyValuePairDTO { description: OpenWhisk Action param key string Param Name value { description: Param value } }] annotations [Action annotations KeyValuePairDTO { description: OpenWhisk Action param key string Param Name value { description: Param value } }] limits LimitsDTO { description: OpenWhisk Action Limits timeout string Action timeout memory string Action memory limit logs string Action logs } exec ExecDTO { description: OpenWhisk Action exec details kind string Action kind binary boolean default: false Is action binary components [ Action components in case of sequence string] } url string Action url }]

Responses:

Response content type: application/json

Code
Description
default
Successful operation

GET /runtime/namespaces/orgId/intId/actions/name

Returns the details of an action.

Parameters:

Name
Description
orgId (string: path)
Organization ID
intId (string: path)
Integration ID
name (string: path)
Action name
Authorization (string: header)
Authorization token in format: Bearer {token}
X-Api-Key (string: header)
Api key

Responses:

Response content type: application/json

Code
Description
200
Successful operation Example value:
{ "name": "string", "namespace": "string", "activationId": "string", "annotations": [ { "key": "string", "value": {} } ], "duration": 0, "version": "string", "response": {} } Model: [ActionDTO { description: OpenWhisk Action name string Action name code string Action code namespace string Action namespace version string Action version params [Action params KeyValuePairDTO { description: OpenWhisk Action param key string Param Name value { description: Param value } }] annotations [Action annotations KeyValuePairDTO { description: OpenWhisk Action param key string Param Name value { description: Param value } }] limits LimitsDTO { description: OpenWhisk Action Limits timeout string Action timeout memory string Action memory limit logs string Action logs } exec ExecDTO { description: OpenWhisk Action exec details kind string Action kind binary boolean default: false Is action binary components [ Action components in case of sequence string] } url string Action url }]

POST /runtime/namespaces/orgId/intId/actions/name

Executes an action.

Parameters:

Name
Description
orgId (string: path)
Organization ID
intId (string: path)
Integration ID
name (string: path)
Action name
Authorization (string: header)
Authorization token in format: Bearer {token}
X-Api-Key (string: header)
Api key

Responses:

Response content type: application/json

Code
Description
200
Successful operation Example value:
{ "name": "string", "code": "string", "namespace": "string", "version": "string", "params": [ { "key": "string", "value": {} } ], "annotations": [ { "key": "string", "value": {} } ], "limits": { "timeout": "string", "memory": "string", "logs": "string" }, "exec": { "kind": "string", "binary": false, "components": [ "string" ] }, "url": "string" } Model: [ActionResultDTO { description: OpenWhisk Action invocation result name string Action name code string Action code namespace string Action namespace version string Action version annotations [Action annotations KeyValuePairDTO { description: OpenWhisk Action param key string Param Name value { description: Param value } }] duration integer($int32) Duration version string Action Version response { description: Action invocation response }

PUT /runtime/namespaces/orgId/intId/actions/name

Updates an action.

Parameters:

Name
Description
orgId (string: path)
Organization ID
intId (string: path)
Integration ID
name (string: path)
Action name
Authorization (string: header)
Authorization token in format: Bearer token
X-Api-Key (string: header)
Api key
body (body)
Action form. Example value:
{ "name": "string", "code": "string", "namespace": "string", "version": "string", "params": [ { "key": "string", "value": {} } ], "annotations": [ { "key": "string", "value": {} } ], "limits": { "timeout": "string", "memory": "string", "logs": "string" }, "exec": { "kind": "string", "binary": false, "components": [ "string" ] }, "url": "string" }Parameter content type: application/json Model: [ActionDTO { description: OpenWhisk Action name string Action name code string Action code namespace string Action namespace version string Action version params [Action params KeyValuePairDTO { description: OpenWhisk Action param key string Param Name value { description: Param value } }] annotations [Action annotations KeyValuePairDTO { description: OpenWhisk Action param key string Param Name value { description: Param value } }] limits LimitsDTO { description: OpenWhisk Action Limits timeout string Action timeout memory string Action memory limit logs string Action logs } exec ExecDTO { description: OpenWhisk Action exec details kind string Action kind binary boolean default: false Is action binary components [ Action components in case of sequence string] } url string Action url }]

Responses:

Response content type: application/json

Code
Description
default
Successful operation

DELETE /runtime/namespaces/orgId/intId/actions/name

Deletes an action.

Parameters:

Name
Description
orgId (string: path)
Organization ID
intId (string: path)
Integration ID
name (string: path)
Action name
Authorization (string: header)
Authorization token in format: Bearer {token}
X-Api-Key (string: header)
Api key

Responses:

Response content type: application/json

Code
Description
default
Successful operation

GET /runtime/system/actions

Returns a list of built-in actions.

Parameters:

Name
Description
Authorization (string: header)
Authorization token in format: Bearer {token}
X-Api-Key (string: header)
Api key

Responses:

Response content type: application/json

Code
Description
200
Successful operationExample value:
[ { "name": "string", "code": "string", "namespace": "string", "version": "string", "params": [ { "key": "string", "value": {} } ], "annotations": [ { "key": "string", "value": {} } ], "limits": { "timeout": "string", "memory": "string", "logs": "string" }, "exec": { "kind": "string", "binary": false, "components": [ "string" ] }, "url": "string" } ] Model: [ActionDTO { description: OpenWhisk Action name string Action name code string Action code namespace string Action namespace version string Action version params [Action params KeyValuePairDTO { description: OpenWhisk Action param key string Param Name value { description: Param value } }] annotations [Action annotations KeyValuePairDTO { description: OpenWhisk Action param key string Param Name value { description: Param value } }] limits LimitsDTO { description: OpenWhisk Action Limits timeout string Action timeout memory string Action memory limit logs string Action logs } exec ExecDTO { description: OpenWhisk Action exec details kind string Action kind binary boolean default: false Is action binary components [ Action components in case of sequence string] } url string Action url }]

POST /runtime/namespaces/orgId/intId/handleEventRegistration

Registers an event registration and assigns a given action to the event.

Parameters:

Name
Description
orgId (string: path)
Organization ID
intId (string: path)
Integration ID
Authorization (string: header)
Authorization token in format: Bearer token
X-Ams-Consumer-Id (string: header)
AMS consumer ID
X-Ams-Application-Id (string: header)
AMS application ID
X-Api-Key (string: header)
Api key
body (body)
Example value:
{ "id": "string", "name": "string", "description": "string", "client_id": "string", "type": "string", "integration_status": "string", "delivery_type": "string", "webhook_url": "string", "events_of_interest": [ { "event_code": "string", "provider": "string" } ], "runtime_action": "string", "registration_id": "string" }Parameter content type: application/json Model: EventDTO { description: Adobe I/O Event Details id string Event id name string Event name description string Event code Client id string Event namespace type string Event type integration_status string Event integration status delivery_type string Event delivery type webhook_url string Webhook url events_of_interest [ Events of interest to listen to EventsOfInterestDTO{ description: Events of interest event_code string Event code provider string Event provider }] runtime_action string Action to handle event registration_id string Event registration id }

Responses:

Response content type: application/json

Code
Description
200
Successful operation Example value:
{ "id": "string", "name": "string", "description": "string", "client_id": "string", "type": "string", "integration_status": "string", "delivery_type": "string", "webhook_url": "string", "events_of_interest": [ { "event_code": "string", "provider": "string" } ], "runtime_action": "string", "registration_id": "string" } Model: EventDTO { description: Adobe I/O Event Details id string Event id name string Event name description string Event code Client id string Event namespace type string Event type integration_status string Event integration status delivery_type string Event delivery type webhook_url string Webhook url events_of_interest [ Events of interest to listen to EventsOfInterestDTO{ description: Events of interest event_code string Event code provider string Event provider }] runtime_action string Action to handle event registration_id string Event registration id }

DELETE /runtime/namespaces/orgId/intId/handleEventDeletion/clientId/registrationId

Deletes an event registration.

Parameters:

Name
Description
orgId (string: path)
Organization ID
intId (string: path)
Integration ID
clientId (string: path)
IMS client ID
registrationId (string: path)
ID of registration
X-Ams-Consumer-Id (string: path)
AMS consumer ID
X-Ams-Application-Id (string: path)
AMS application ID
Authorization (string: header)
Authorization token in format: Bearer {token}
X-Api-Key (string: header)
Api key

Responses:

Response content type: application/json

Code
Description
default
Successful operation

PUT /runtime/namespaces/orgId/intId/handleEventUpdate/clientId/registrationId

Updates an event registration.

Parameters:

Name
Description
orgId (string: path)
Organization ID
intId (string: path)
Integration ID
clientId (string: path)
IMS client ID
registrationId (string: path)
Registration ID
X-Ams-Consumer-Id (string: header)
AMS consumer ID
X-Ams-Application-Id (string: header)
AMS application ID
Authorization (string: header)
Authorization token in format: Bearer token
X-Api-Key (string: header)
Api key
body (body)
Example value:
{ "id": "string", "name": "string", "description": "string", "client_id": "string", "type": "string", "integration_status": "string", "delivery_type": "string", "webhook_url": "string", "events_of_interest": [ { "event_code": "string", "provider": "string" } ], "runtime_action": "string", "registration_id": "string" }Parameter content type: application/json Model: EventDTO { description: Adobe I/O Event Details id string Event id name string Event name description string Event code Client id string Event namespace type string Event type integration_status string Event integration status delivery_type string Event delivery type webhook_url string Webhook url events_of_interest [ Events of interest to listen to EventsOfInterestDTO{ description: Events of interest event_code string Event code provider string Event provider }] runtime_action string Action to handle event registration_id string Event registration id }

Responses:

Response content type: application/json

Code
Description
200
Successful operation Example value:
{ "id": "string", "name": "string", "description": "string", "client_id": "string", "type": "string", "integration_status": "string", "delivery_type": "string", "webhook_url": "string", "events_of_interest": [ { "event_code": "string", "provider": "string" } ], "runtime_action": "string", "registration_id": "string" } Model: EventDTO { description: Adobe I/O Event Details id string Event id name string Event name description string Event code Client id string Event namespace type string Event type integration_status string Event integration status delivery_type string Event delivery type webhook_url string Webhook url events_of_interest [ Events of interest to listen to EventsOfInterestDTO{ description: Events of interest event_code string Event code provider string Event provider }] runtime_action string Action to handle event registration_id string Event registration id }

POST /runtime/namespaces/orgId/intId/handleEventStatus/clientId/registrationId/status

Updates the status of an event registration.

Parameters:

Name
Description
orgId (string: path)
Organization ID
intId (string: path)
Integration ID
clientId (string: path)
IMS client ID
registrationId (string: path)
ID of registration
status (string: path)
Status of the registration
X-Ams-Consumer-Id (string: path)
AMS consumer ID
X-Ams-Application-Id (string: path)
AMS application ID
Authorization (string: header)
Authorization token in format: Bearer {token}
X-Api-Key (string: header)
Api key

Responses:

Response content type: application/json

Code
Description
200
Successful operation Example value:
{ "id": "string", "name": "string", "description": "string", "client_id": "string", "type": "string", "integration_status": "string", "delivery_type": "string", "webhook_url": "string", "events_of_interest": [ { "event_code": "string", "provider": "string" } ], "runtime_action": "string", "registration_id": "string" } Model: EventDTO { description: Adobe I/O Event Details id string Event id name string Event name description string Event code Client id string Event namespace type string Event type integration_status string Event integration status delivery_type string Event delivery type webhook_url string Webhook url events_of_interest [ Events of interest to listen to EventsOfInterestDTO{ description: Events of interest event_code string Event code provider string Event provider }] runtime_action string Action to handle event registration_id string Event registration id }

Next steps

Return to the Runtime Reference Documentation Index.

Return to the Guides Index.