api.md

Korifi API Documentation

This document lists all the CF API endpoints supported by Korifi and their parameters.

Apps

Create an app

Supported parameters:

All parameters are supported. lifecycle will be ignored and overridden with the default configured values.

Get an app

Supported query parameters:

No query parameters are supported.

List apps

Supported query parameters:

• names
• space_guids
• order_by (the only supported value is name)

Delete an app

This endpoint is fully supported.

Get current droplet

This endpoint is fully supported.

Get environment for an app

Warning The field system_env_json will not be redacted.

Set current droplet

This endpoint is fully supported.

Start an app

This endpoint is fully supported.

Stop an app

This endpoint is fully supported.

Restart an app

This endpoint is fully supported.

Update environment variables for an app

This endpoint is fully supported.

Builds

Create a build

All parameters are supported. lifecycle will be ignored and overridden with the default configured values.

Get a build

This endpoint is fully supported.

Buildpacks

List buildpacks

Supported query parameters:

No query parameters are supported.

Domains

List Domains

Supported query parameters:

• names

List domains for an organization

Supported query parameters:

• names

Droplets

Get a droplet

Warning No fields will be redacted.

List droplets for a package

Supported query parameters:

No query parameters are supported.

Jobs

Get a job

Warning This endpoint always returns an empty resource with state: "COMPLETE".

Manifests

Apply a manifest to a space

Korifi only supports manifests with a single entry in applications.

Supported parameters:

• applications[0].name
• applications[0].env
• applications[0].memory (sets memory for the web process)
• applications[0].processes
• applications[0].no-route
• applications[0].routes[0].route

Create a manifest diff for a space

Warning This endpoint always returns an empty diff.

Organizations

Create an organization

Supported parameters:

• name

List organizations

Supported query parameters:

• names

Delete an organization

This endpoint is fully supported.

Packages

Create a package

Supported parameters:

• type (the only supported value is bits)
• relationships.app

Get a package

This endpoint is fully supported.

List Package

Supported query parameters:

• app_guids
• states
• order_by (the only supported value is created_at)

Upload package bits

Supported parameters:

• bits

Processes

Get a process

These endpoints are fully supported.

Get stats for a process

GET /v3/apps/:guid/processes/:type/stats is not supported.

Supported fields:

• index
• state

List processes

Supported query parameters:

• app_guids

List processes for app

Supported query parameters:

No query parameters are supported.

Update a process

Supported parameters:

• command
• health_check

Scale a process

This endpoint is fully supported.

Resource Matches

Create a resource match

Warning CF for VMs uses a technique called "resource matching" as an optimization to support partial app uploads to the blobstore. Korifi does not support this feature and this endpoint will always return an empty list of matched resources.

Roles

Create a role

Supported parameters:

• type (the only supported value is space_developer
• relationships.user
• relationships.organization
• relationships.space

Root

Global API Root

Supported fields:

• self
• cloud_controller_v3
• login
• log_cache

V3 API Root

Supported fields:

• links.self

Routes

Create a route

Supported parameters:

• relationships.space
• relationships.domain
• host
• path
• metadata.annotations
• metadata.labels

Get a route

Supported query parameters:

No query parameters are supported.

List routes

Supported query parameters:

• app_guids
• space_guids
• domain_guids
• hosts
• paths

List routes for an app

Supported query parameters:

No query parameters are supported.

Delete a route

This endpoint is fully supported.

List destinations for a route

Supported query parameters:

No query parameters are supported.

Insert destinations for a route

Supported parameters:

• destinations[].app.guid
• destinations[].app.process.type
• destinations[].port
• destinations[].protocol

Remove destination for a route

This endpoint is fully supported.

Service Instances

Korifi only supports user-provided service instances. Managed service operations and fields are not supported.

Create a service instance

Supported parameters:

• type (must be user-provided)
• name
• relationships.space
• tags
• credentials
• metadata.labels
• metadata.annotations

List service instances

Supported query parameters:

• names
• space_guids
• order_by (the only supported values are name, created_at and updated_at)

Delete a service instance

Supported query parameters:

No query parameters are supported.

Service Credential Bindings

Create a service credential binding

Supported parameters:

• name
• type (the only supported value is app)
• relationships.service_instance
• relationships.app

List service credential bindings

Supported query parameters:

• service_instance_guids
• app_guids
• type
• include (the only supported value is app)

Delete a service credential binding

This endpoint is fully supported.

Service Route Bindings

List service route bindings

Warning This endpoint always returns an empty list.

Sidecars

List sidecars for process

Warning This endpoint always returns an empty list.

Spaces

Create a space

Supported parameters:

• name
• relationships.guid

List spaces

Supported query parameters:

• names
• organization_guids

Delete a space

This endpoint is fully supported.

Tasks

Create a task

Supported parameters:

• command

Get a task

This endpoint is fully supported.

List tasks

Supported query parameters:

No query parameters are supported.

List tasks for an app

Supported query parameters:

• sequence_ids

Cancel a task

These endpoints are fully supported.

User Identity

Warning This is not part of the published CF API, and is not supported on CF on VMs.

These endpoints are needed by the CF CLI when targeting a Korifi instance to properly identify the user.

Get the current username

Definition

GET /whoami

Log-Cache

Info

Warning This endpoint is unauthenticated. This endpoint will always return a hard-coded response.

Read

Supported query parameters:

• start_time
• limit
• descending