Skip to content
API Reference
/
core
/
core_launcher_create

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server

https://docs.ibl.ai/_mock/apis/ibl/

https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

career

Operations

catalog

Operations

core

Operations

core_launcher_retrieve

Request

GET Launch status

Params: key user_id: Optional

Security
PlatformApiKeyAuthentication
Query
keystringnon-emptyrequired
user_idinteger
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/core/launcher/?key=string&user_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
keystring<= 200 charactersrequired

The platform key

namestring or null<= 200 characters

The name of the platform

orgstring or null<= 200 characters

The associated edX org code

lms_urlstring or null(uri)<= 300 characters

The LMS URL for the platform

cms_urlstring or null(uri)<= 300 characters

The CMS URL for the platform

portal_urlstring or null(uri)<= 300 characters

The portal URL for the platform

statusinteger[ -2147483648 .. 2147483647 ]
  • -2 - FAILED
  • -1 - TERMINATED
  • 0 - PENDING
  • 1 - BUILDING
  • 2 - RUNNING
  • 3 - PAUSED
  • 4 - STOPPING
  • 5 - STOPPED
  • 6 - REPAIR
Enum-2-10123456
activeboolean
Response
application/json
{
  "key": "string",
  "name": "string",
  "org": "string",
  "lms_url": "http://example.com",
  "cms_url": "http://example.com",
  "portal_url": "http://example.com",
  "status": -2,
  "active": true
}

core_launcher_create

Request

POST: Launch a new edX platform

Params: user_id: The ID of the requesting user (required) key: The Deep LMS subdomain (required) name: The edX platform name ("optional") org: The edX organization ("optional") lms_url: LMS URL ("optional") cms_url: CMS URL ("optional") portal_url: Portal URL ("optional")

Security
PlatformApiKeyAuthentication
Body
required
user_idintegerrequired
keystringrequired
namestring
orgstring
lms_urlstring
cms_urlstring
portal_urlstring
curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/core/launcher/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_id": 0,
    "key": "string",
    "name": "string",
    "org": "string",
    "lms_url": "string",
    "cms_url": "string",
    "portal_url": "string"
  }'

Responses

Bodyapplication/json
keystring<= 200 charactersrequired

The platform key

namestring or null<= 200 characters

The name of the platform

orgstring or null<= 200 characters

The associated edX org code

lms_urlstring or null(uri)<= 300 characters

The LMS URL for the platform

cms_urlstring or null(uri)<= 300 characters

The CMS URL for the platform

portal_urlstring or null(uri)<= 300 characters

The portal URL for the platform

statusinteger[ -2147483648 .. 2147483647 ]
  • -2 - FAILED
  • -1 - TERMINATED
  • 0 - PENDING
  • 1 - BUILDING
  • 2 - RUNNING
  • 3 - PAUSED
  • 4 - STOPPING
  • 5 - STOPPED
  • 6 - REPAIR
Enum-2-10123456
activeboolean
Response
application/json
{
  "key": "string",
  "name": "string",
  "org": "string",
  "lms_url": "http://example.com",
  "cms_url": "http://example.com",
  "portal_url": "http://example.com",
  "status": -2,
  "active": true
}

core_lti_1p3_provider_lti_keys_list

Request

List your LTI Provider Key's

Security
PlatformApiKeyAuthentication
Query
platform_keystringnon-emptyrequired

Platform Key

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/core/lti/1p3/provider/lti-keys/?platform_key=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
idintegerread-onlyrequired
namestringrequired

Name of the RSA Key

public_keystringread-onlyrequired

Public Key in PEM format

public_jwkanyread-onlyrequired

Public key in JWK format

]
Response
application/json
[
  {
    "id": 0,
    "name": "string",
    "public_key": "string",
    "public_jwk": null
  }
]

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com