Public API

get
List available Resource Types

https://cloud.xapix.io/api/v1/resource_types
List all the available resource types and required context. The context describes the information needed in the URL to work with this resource type. Available contexts: - Organization: resource type can be used for resource APIs which include the Organization - Project: resource type can be used for resource APIs which include the Project
Request
Response
Request
Response
200: OK
List of the available resource types and the required context.
{
"resource_types": [
{
"type": "Credential",
"context": "Project"
},
{
"type": "Schema",
"context": "Project"
},
{
"type": "Project",
"context": "Organization"
},
{
"type": "EndpointGroup",
"context": "Project"
},
{
"type": "Scheduler",
"context": "Project"
},
{
"type": "ApiPublishing",
"context": "Project"
},
{
"type": "Unit",
"context": "Pipeline"
},
{
"type": "Pipeline",
"context": "Project"
},
{
"type": "Endpoint",
"context": "Project"
},
{
"type": "ApiPublishingRole",
"context": "Project"
},
{
"type": "StreamGroup",
"context": "Project"
},
{
"type": "AuthScheme",
"context": "Project"
},
{
"type": "ServiceInstall",
"context": "Project"
},
{
"type": "Stream",
"context": "Project"
},
{
"type": "Ambassador",
"context": "Project"
},
{
"type": "Proxy",
"context": "Project"
},
{
"type": "CacheConnection",
"context": "Project"
},
{
"type": "Service",
"context": "Project"
},
{
"type": "DataSource",
"context": "Project"
}
]
}

get
List Resources in Organization Context

https://cloud.xapix.io/api/v1/orgs/:org/:resource_type
List all resources within an organization context. For supported resource types within this context check the List of available Resource Type API.
Request
Response
Request
Path Parameters
resource_type
required
string
Type of resource to list
org
required
string
Organization slug
Headers
Authentication
required
string
Use the Bearer format to supply a valid access token
Response
200: OK
List of all resource IDs of given type within the given context.
{
"resource_ids": [ "project_id_1", "project_id_2", ... ]
}
404: Not Found
Returned in case the given organization does not exist or if the user does not have access to this organization.
{
"errors": [
{
"title": "Not Found",
"status": 404,
"detail": "Resource not found"
}
]
}

get
List Resources in Project Context

https://cloud.xapix.io/api/v1/projects/:org/:project/:resource_type
List all resources within a project context. For supported resource types within this context see the List of available Resource Type API.
Request
Response
Request
Path Parameters
project
required
string
Project slug
org
required
string
Organization slug
resource_type
required
string
Type of resource to list
Response
200: OK
List of all resource IDs of given resource type within the given context.
{
"resource_ids": [ "resource_id_1", "resource_id_2", ... ]
}