Skip to content
API Reference
/
commerce
/
providers_aws_launch_tenant_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

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

providers_aws_domain_status_retrieve

Request

API endpoint to get domain setup status

Security
PlatformApiKeyAuthentication
curl -i -X GET \
  https://docs.ibl.ai/_mock/apis/ibl/api/providers/aws/domain-status/ \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

providers_aws_launch_tenant_create

Request

Proxy to the Platform launch API

We cannot expose launching a tenant to an authorized user hence the need for the API

The API validates the x_amzn_marketplace_token and then proxies the request to the Platform Launch API

Body
required
usernamestringrequired
emailstring(email)required
firstnamestring
Default ""
lastnamestring
Default ""
passwordstring
namestringrequired

Organization name

keystringrequired

Unique key for the organization

ignore_user_existsboolean
Default false
aws_transaction_idstringrequired

AWS Marketplace Customer Id and Product Code Identifier

curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/providers/aws/launch-tenant/ \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "string",
    "email": "user@example.com",
    "firstname": "",
    "lastname": "",
    "password": "string",
    "name": "string",
    "key": "string",
    "ignore_user_exists": false,
    "aws_transaction_id": "string"
  }'

Responses

Bodyapplication/json
successboolean
Default true
messageanyrequired
dataany
idstring
timestampstring
orgstringrequired
lms_urlstringrequired
cms_urlstringrequired
portal_urlstringrequired
edx_rolestringrequired
Response
application/json
{
  "success": true,
  "message": null,
  "data": null,
  "id": "string",
  "timestamp": "string",
  "org": "string",
  "lms_url": "string",
  "cms_url": "string",
  "portal_url": "string",
  "edx_role": "string"
}

providers_aws_sync_domain_records_retrieve

Request

API endpoint to get/update CNAME records for domain setup

Security
PlatformApiKeyAuthentication
curl -i -X GET \
  https://docs.ibl.ai/_mock/apis/ibl/api/providers/aws/sync-domain-records/ \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

recommendations

Operations

reports

Operations

skills

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