Infoworks Presets API
CRUD Operations to manage user specific presets
CRUD Operations to manage user specific presets
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/infoworks:infoworks-presets-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
contact: {}
title: Infoworks Rest API V3 Presets API
version: '1.0'
description: Infoworks Rest API V3
servers:
- url: '{protocol}://{host}:{port}/v3'
variables:
protocol:
default: http
enum:
- http
- https
host:
default: localhost
port:
default: '3001'
tags:
- name: Presets
description: CRUD Operations to manage user specific presets
paths:
/users/self/presets:
get:
security:
- BearerAuth: []
summary: List presets
description: Get a list of presets of a particular type for a user
operationId: listPresets
tags:
- Presets
parameters:
- in: query
name: type
required: true
schema:
type: string
enum:
- prodops_filter
description: Type of presets to fetch for the user
- name: offset
in: query
description: The number of items to skip before starting to collect the result set
schema:
type: integer
default: 0
- name: limit
in: query
description: The numbers of items to return
schema:
type: integer
default: 10
- name: sort_by
in: query
description: Sort result on field
schema:
type: string
- name: order_by
in: query
description: order ascending | descending
schema:
type: string
default: asc
enum:
- asc
- desc
- name: filter
in: query
description: Filter results query
schema:
type: string
responses:
'200':
description: List of presets.
content:
application/json:
schema:
allOf:
- type: object
properties:
message:
type: string
example: Example Success Message
- type: object
properties:
limit:
type: integer
example: 10
offset:
type: integer
example: 0
links:
type: object
properties:
base:
type: string
format: uri
example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
self:
type: string
format: uri
example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
next:
type: string
format: uri
example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
total_count:
type: integer
example: 10
x-examples:
example-1: {}
- type: object
properties:
result:
type: array
items:
oneOf:
- type: object
properties:
id:
type: string
example: 67a1e86f770b8c2230e18e00
user_id:
type: string
example: 6RkfybTRQQByEey3v
name:
type: string
example: preset1
type:
type: string
example: prodops_filter
configuration:
type: object
is_default:
type: boolean
example: true
created_at:
type: string
format: date-time
example: '2025-02-04T10:14:07.024Z'
modified_at:
type: string
format: date-time
example: '2025-02-05T06:05:00.096Z'
username:
type: string
example: Infoworks Admin
'400':
description: Request has invalid body or parameters.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10006
help:
type: string
example: http://api.infoworks.io/help/IW10006
'401':
description: Authentication Failed. Please check your Credentials
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10005
help:
type: string
example: http://api.infoworks.io/help/IW10005
'403':
description: Forbidden. User lacks access to specified resource.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10004
help:
type: string
example: http://api.infoworks.io/help/IW10004
'500':
description: Internal Server Error.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10002
help:
type: string
example: http://api.infoworks.io/help/IW10002
post:
security:
- BearerAuth: []
summary: Create a preset
description: Creates a user-defined preset
operationId: createPreset
tags:
- Presets
requestBody:
content:
application/json:
schema:
oneOf:
- type: object
properties:
name:
type: string
example: preset1
type:
type: string
example: prodops_filter
configuration:
type: object
is_default:
type: boolean
example: true
responses:
'200':
description: Ok.
content:
application/json:
schema:
allOf:
- type: object
properties:
message:
type: string
example: Example Success Message
- type: object
properties:
result:
type: object
properties:
id:
type: string
example: 5fa948e77758f33e0e83ec6b
'400':
description: Request has invalid body or parameters.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10006
help:
type: string
example: http://api.infoworks.io/help/IW10006
'401':
description: Authentication Failed. Please check your Credentials
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10005
help:
type: string
example: http://api.infoworks.io/help/IW10005
'403':
description: Forbidden. User lacks access to specified resource.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10004
help:
type: string
example: http://api.infoworks.io/help/IW10004
'500':
description: Internal Server Error.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10002
help:
type: string
example: http://api.infoworks.io/help/IW10002
/users/self/presets/{preset_id}:
parameters:
- name: preset_id
in: path
description: Preset Id
required: true
schema:
type: string
get:
security:
- BearerAuth: []
summary: Get preset
description: Get preset details
operationId: getPreset
tags:
- Presets
responses:
'200':
description: Ok.
content:
application/json:
schema:
allOf:
- type: object
properties:
message:
type: string
example: Example Success Message
- type: object
properties:
result:
oneOf:
- type: object
properties:
id:
type: string
example: 67a1e86f770b8c2230e18e00
user_id:
type: string
example: 6RkfybTRQQByEey3v
name:
type: string
example: preset1
type:
type: string
example: prodops_filter
configuration:
type: object
is_default:
type: boolean
example: true
created_at:
type: string
format: date-time
example: '2025-02-04T10:14:07.024Z'
modified_at:
type: string
format: date-time
example: '2025-02-05T06:05:00.096Z'
username:
type: string
example: Infoworks Admin
'400':
description: Request has invalid body or parameters.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10006
help:
type: string
example: http://api.infoworks.io/help/IW10006
'401':
description: Authentication Failed. Please check your Credentials
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10005
help:
type: string
example: http://api.infoworks.io/help/IW10005
'403':
description: Forbidden. User lacks access to specified resource.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10004
help:
type: string
example: http://api.infoworks.io/help/IW10004
'500':
description: Internal Server Error.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10002
help:
type: string
example: http://api.infoworks.io/help/IW10002
patch:
security:
- BearerAuth: []
summary: Update preset
operationId: updatePreset
tags:
- Presets
requestBody:
content:
application/json:
schema:
oneOf:
- type: object
properties:
name:
type: string
example: preset1
type:
type: string
example: prodops_filter
configuration:
type: object
is_default:
type: boolean
example: true
responses:
'200':
description: Ok.
content:
application/json:
schema:
allOf:
- type: object
properties:
message:
type: string
example: Example Success Message
- type: object
properties:
result:
type: object
properties:
id:
type: string
example: 5fa948e77758f33e0e83ec6b
'400':
description: Request has invalid body or parameters.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10006
help:
type: string
example: http://api.infoworks.io/help/IW10006
'401':
description: Authentication Failed. Please check your Credentials
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10005
help:
type: string
example: http://api.infoworks.io/help/IW10005
'403':
description: Forbidden. User lacks access to specified resource.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10004
help:
type: string
example: http://api.infoworks.io/help/IW10004
'500':
description: Internal Server Error.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10002
help:
type: string
example: http://api.infoworks.io/help/IW10002
delete:
security:
- BearerAuth: []
summary: Delete preset
operationId: deletePreset
tags:
- Presets
responses:
'200':
description: Ok.
content:
application/json:
schema:
allOf:
- type: object
properties:
message:
type: string
example: Example Success Message
'400':
description: Request has invalid body or parameters.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10006
help:
type: string
example: http://api.infoworks.io/help/IW10006
'401':
description: Authentication Failed. Please check your Credentials
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10005
help:
type: string
example: http://api.infoworks.io/help/IW10005
'403':
description: Forbidden. User lacks access to specified resource.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10004
help:
type: string
example: http://api.infoworks.io/help/IW10004
'500':
description: Internal Server Error.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10002
help:
type: string
example: http://api.infoworks.io/help/IW10002
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
BasicAuth:
type: http
scheme: basic