Apps
Apps API endpoints
Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Response Body
curl -X GET "http://localhost:3013/api/apps"Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X POST "http://localhost:3013/api/apps" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= lengthResponse Body
curl -X DELETE "http://localhost:3013/api/apps/string"Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= lengthResponse Body
curl -X GET "http://localhost:3013/api/apps/string"Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PATCH "http://localhost:3013/api/apps/string" \ -H "Content-Type: application/json" \ -d '{}'{
"app": null,
"migration": {
"scanned": 0,
"backfilled": 0,
"coerced": 0,
"mapped": 0,
"elsed": 0,
"purgedValues": 0,
"idxRebuilt": 0,
"orphanFields": [
"string"
],
"userConfigChanged": [
"string"
]
}
}Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PUT "http://localhost:3013/api/apps/string" \ -H "Content-Type: application/json" \ -d '{}'{
"app": null,
"migration": {
"scanned": 0,
"backfilled": 0,
"coerced": 0,
"mapped": 0,
"elsed": 0,
"purgedValues": 0,
"idxRebuilt": 0,
"orphanFields": [
"string"
],
"userConfigChanged": [
"string"
]
}
}Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= length^[a-z][a-zA-Z0-9_]{0,39}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X POST "http://localhost:3013/api/apps/string/actions/string" \ -H "Content-Type: application/json" \ -d '{}'Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= length^[a-z][a-zA-Z0-9_]{0,39}$Query Parameters
0 < value <= 1000Response Body
curl -X GET "http://localhost:3013/api/apps/string/models/string/rows"Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= length^[a-z][a-zA-Z0-9_]{0,39}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X POST "http://localhost:3013/api/apps/string/models/string/rows" \ -H "Content-Type: application/json" \ -d '{ "values": { "property1": null, "property2": null } }'Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= length^[a-z][a-zA-Z0-9_]{0,39}$1 <= lengthResponse Body
curl -X DELETE "http://localhost:3013/api/apps/string/models/string/rows/string"Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= length^[a-z][a-zA-Z0-9_]{0,39}$1 <= lengthResponse Body
curl -X GET "http://localhost:3013/api/apps/string/models/string/rows/string"Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= length^[a-z][a-zA-Z0-9_]{0,39}$1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X PATCH "http://localhost:3013/api/apps/string/models/string/rows/string" \ -H "Content-Type: application/json" \ -d '{ "values": { "property1": null, "property2": null } }'Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= length^[a-z][a-zA-Z0-9_]{0,39}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X POST "http://localhost:3013/api/apps/string/models/string/rows/bulk" \ -H "Content-Type: application/json" \ -d '{ "rows": [ { "values": { "property1": null, "property2": null } } ] }'Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= length^[a-z][a-zA-Z0-9_]{0,39}$Response Body
curl -X GET "http://localhost:3013/api/apps/string/queries/string"Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "http://localhost:3013/api/apps/string/rollback" \ -H "Content-Type: application/json" \ -d '{ "version": 0 }'{
"app": null,
"migration": {
"scanned": 0,
"backfilled": 0,
"coerced": 0,
"mapped": 0,
"elsed": 0,
"purgedValues": 0,
"idxRebuilt": 0,
"orphanFields": [
"string"
],
"userConfigChanged": [
"string"
]
}
}Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= lengthResponse Body
curl -X GET "http://localhost:3013/api/apps/string/user-config"Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X PUT "http://localhost:3013/api/apps/string/user-config" \ -H "Content-Type: application/json" \ -d '{ "values": { "property1": null, "property2": null } }'Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= lengthResponse Body
curl -X GET "http://localhost:3013/api/apps/string/versions"Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= length0 < valueResponse Body
curl -X GET "http://localhost:3013/api/apps/string/versions/0"