Skip to content

Latest commit

 

History

History
469 lines (268 loc) · 12.5 KB

api.md

File metadata and controls

469 lines (268 loc) · 12.5 KB

Korifi API Documentation

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

Supported parameters:

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

Supported query parameters:

No query parameters are supported.

Supported query parameters:

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

This endpoint is fully supported.

This endpoint is fully supported.

Warning The field system_env_json will not be redacted.

This endpoint is fully supported.

This endpoint is fully supported.

This endpoint is fully supported.

This endpoint is fully supported.

This endpoint is fully supported.

Labels and Annotations are not supported. lifecycle will be ignored and overridden with the default configured values.

This endpoint is fully supported.

Always returns HTTP 422 error.

Supported query parameters:

No query parameters are supported.

Supported query parameters:

  • names

Supported query parameters:

  • names

Warning No fields will be redacted.

Supported query parameters:

No query parameters are supported.

Updating image is not supported.

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

Supported parameters:

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

Warning This endpoint always returns an empty diff.

Supported parameters:

  • name

Supported query parameters:

  • names

This endpoint is fully supported.

Supported parameters:

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

This endpoint is fully supported.

Supported query parameters:

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

Supported parameters:

  • bits

These endpoints are fully supported.

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

Supported fields:

  • index
  • state

Supported query parameters:

  • app_guids

Supported query parameters:

No query parameters are supported.

Supported parameters:

  • command
  • health_check

This endpoint is fully supported.

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.

Supported parameters:

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

Supported fields:

  • self
  • cloud_controller_v3
  • login
  • log_cache

Supported fields:

  • links.self

Supported parameters:

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

Supported query parameters:

No query parameters are supported.

Supported query parameters:

  • app_guids
  • space_guids
  • domain_guids
  • hosts
  • paths

Supported query parameters:

No query parameters are supported.

This endpoint is fully supported.

Supported query parameters:

No query parameters are supported.

Supported parameters:

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

This endpoint is fully supported.

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

Supported parameters:

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

Supported query parameters:

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

Supported query parameters:

No query parameters are supported.

Supported parameters:

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

Supported query parameters:

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

This endpoint is fully supported.

Warning This endpoint always returns an empty list.

Warning This endpoint always returns an empty list.

Supported parameters:

  • name
  • relationships.guid

Supported query parameters:

  • names
  • guids
  • organization_guids

This endpoint is fully supported.

Supported parameters:

  • command

This endpoint is fully supported.

Supported query parameters:

No query parameters are supported.

Supported query parameters:

  • sequence_ids

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

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

Supported query parameters:

  • start_time
  • limit
  • descending