Documentation Index

Fetch the complete documentation index at: https://docs.aifabrix.ai/llms.txt

Use this file to discover all available pages before exploring further.

List all template applications

  • Published on Jul 21, 2026
  • 3 minute(s) read
  • MR
 Prev Next
Get
/api/v1/applications

Get a paginated list of applications with filtering and sorting. List items return ApplicationListItem with a slim configuration summary (type, image, port, registryMode only) — not the full deploy manifest. Requires applications:read permission.

Security
OAuth
FlowAuthorization Code
Authorization URL${KEYCLOAK_SERVER_URL}/realms/aifabrix/protocol/openid-connect/auth
Token URL${KEYCLOAK_SERVER_URL}/realms/aifabrix/protocol/openid-connect/token
Query parameters
page
integer

Page number (1-based)

Minimum1
Default1
pageSize
integer

Number of items per page (camelCase - SDK convention)

Minimum1
Maximum100
Default10
sort

Sort order. Prefix field with '-' for descending order. Examples: sort=-createdAt (descending), sort=name (ascending) Multiple sorts: sort[]=-updatedAt&sort[]=name

Example-createdAt
filter
string

Filter query in format: field:operator:value Operators: eq, neq, in, nin, gt, lt, gte, lte, contains, like Examples:

  • filter=status:eq:active
  • filter=createdAt:gte:2024-01-01
  • filter=status:in:active,pending Multiple filters: filter[]=status:eq:active&filter[]=type:eq:webapp
Examplestatus:eq:active
search
string

Search term to match across key, displayName, name, and description fields (case-insensitive partial match)

Examplepayment
Responses
200

Paginated list of template applications (SDK format). Each item is ApplicationListItem without full ApplicationConfig.

Expand All
object

JSON response for List all template applications

data
Array of object (ApplicationListItem)

Slim application rows for the current page

object

Application row for list endpoints. configuration is ApplicationListConfiguration only; full ApplicationConfig is returned by GET /api/v1/applications/.

id
string

Application database ID

key
string

Application key (unique identifier)

displayName
string

Display name from the Application database row

description
string | null

Optional human-readable application description

image
string | null

Container image reference currently associated with the application

url
string | null

Public / external application URL when known

port
integer | null

Application listen port when configured

registryMode
string | null

Container registry mode for the application image

Valid values[ "acr", "external", "public" ]
configuration
object

Slim configuration summary for list responses (type, image, port, registryMode only). Use GET by key for full ApplicationConfig.

type
string
Valid values[ "webapp", "functionapp", "api", "service", "external" ]
image
string
port
integer
Minimum1
Maximum65535
registryMode
string
Valid values[ "acr", "external", "public" ]
status
string

Application lifecycle / health status

currentVersion
string | null

Currently registered version or image tag when known

createdAt
string (date-time)

When the application record was created

updatedAt
string (date-time)

When the application record was last updated

meta
object

Pagination metadata following SDK camelCase convention

totalItems
integer

Total number of items in the full dataset

Example100
currentPage
integer

Current page number (1-based)

Minimum1
Example1
pageSize
integer

Number of items per page

Minimum1
Maximum100
Example10
type
string

Logical resource type (e.g., 'environment', 'application', 'deployment')

Exampleenvironment
links
object (PaginationLinks)

Pagination links

self
string (uri-reference)

Current page URL

Example/api/v1/dimensions?page=1&pageSize=10
first
string (uri-reference)

First page URL

Example/api/v1/dimensions?page=1&pageSize=10
last
string (uri-reference)

Last page URL

Example/api/v1/dimensions?page=3&pageSize=10
prev
string (uri-reference) | null

Previous page URL (null if on first page)

next
string (uri-reference) | null

Next page URL (null if on last page)

Example/api/v1/dimensions?page=2&pageSize=10
401

Unauthorized - authentication required

{
  "type": "/Errors/Unauthorized",
  "title": "Unauthorized",
  "status": "401",
  "detail": "Authentication required",
  "instance": "/api/v1/applications",
  "correlationId": "corr_1234567890_abc123"
}
Expand All
object

Unauthorized error

type
string
Example/Errors/BadRequest
title
string
ExampleBad Request
status
integer
Example400
detail
string
ExampleRequest validation failed
instance
string (uri-reference)
Example/api/v1/applications
correlationId
string
Examplecorr_1234567890_abc123
errors
Array of object (ValidationError)
object
field
string
message
string
value
string | null
required
object
permissions
Array of string
Example[ "environments-applications:create" ]
string
roles
Array of string
Example[ "aifabrix-platform-admin" ]
string
requireAll
boolean
ExampleFalse
missing
object
permissions
Array of string
Example[ "environments-applications:create" ]
string
roles
Array of string
Example[ "aifabrix-platform-admin" ]
string
userPermissions
Array of string
Example[]
string
userRoles
Array of string
Example[]
string
authMethod
string | null
403

Forbidden - insufficient permissions

{
  "type": "/Errors/Forbidden",
  "title": "Forbidden",
  "status": "403",
  "detail": "Insufficient permissions to access this resource",
  "instance": "/api/v1/applications",
  "correlationId": "corr_1234567890_abc123"
}
Expand All
object

Forbidden error

type
string
Example/Errors/BadRequest
title
string
ExampleBad Request
status
integer
Example400
detail
string
ExampleRequest validation failed
instance
string (uri-reference)
Example/api/v1/applications
correlationId
string
Examplecorr_1234567890_abc123
errors
Array of object (ValidationError)
object
field
string
message
string
value
string | null
required
object
permissions
Array of string
Example[ "environments-applications:create" ]
string
roles
Array of string
Example[ "aifabrix-platform-admin" ]
string
requireAll
boolean
ExampleFalse
missing
object
permissions
Array of string
Example[ "environments-applications:create" ]
string
roles
Array of string
Example[ "aifabrix-platform-admin" ]
string
userPermissions
Array of string
Example[]
string
userRoles
Array of string
Example[]
string
500

Internal server error

{
  "type": "/Errors/InternalServerError",
  "title": "Internal Server Error",
  "status": "500",
  "detail": "An internal server error occurred",
  "instance": "/api/v1/applications",
  "correlationId": "corr_1234567890_abc123"
}
Expand All
object

Internal server error

type
string
Example/Errors/BadRequest
title
string
ExampleBad Request
status
integer
Example400
detail
string
ExampleRequest validation failed
instance
string (uri-reference)
Example/api/v1/applications
correlationId
string
Examplecorr_1234567890_abc123
errors
Array of object (ValidationError)
object
field
string
message
string
value
string | null
required
object
permissions
Array of string
Example[ "environments-applications:create" ]
string
roles
Array of string
Example[ "aifabrix-platform-admin" ]
string
requireAll
boolean
ExampleFalse
missing
object
permissions
Array of string
Example[ "environments-applications:create" ]
string
roles
Array of string
Example[ "aifabrix-platform-admin" ]
string
userPermissions
Array of string
Example[]
string
userRoles
Array of string
Example[]
string