openapi: 3.0.0

info:

version: 1.1.1

title: Sysdig Public API

description: |-

Sysdig Public API.

contact:

name: Sysdig

url: https://sysdig.com

email: info@sysdig.com

license:

name: Sysdig License

url: https://docs.sysdig.com/en/docs/administration/administration-settings/subscription/

security:

- bearerAuth: []

paths:

/monitor/cost-advisor/v1/pricing:

x-excluded-environments:

- OnPrem

get:

summary: List Pricing

description: |

Retrieve a paginated list of pricing.\

\

**Required permissions:** _cost-advisor.read_

operationId: getPricingV1

tags:

- Cost Advisor Custom Pricing

parameters:

- $ref: '#/components/parameters/Offset'

- $ref: '#/components/parameters/Limit'

- name: clusterName

in: query

description: |

The name of the Kubernetes cluster for which you want to retrive the pricing.

required: false

schema:

type: string

maxLength: 256

example: prod-us-1

- name: type

in: query

description: |

The type of pricing to find.

required: false

schema:

$ref: '#/components/schemas/PricingType'

responses:

'200':

description: The pricing page.

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

content:

application/json:

schema:

$ref: '#/components/schemas/GetPricingPaginatedResponseV1'

'400':

$ref: '#/components/responses/BadRequest'

'401':

$ref: '#/components/responses/Unauthorized'

'404':

$ref: '#/components/responses/NotFound'

'429':

$ref: '#/components/responses/TooManyRequests'

'500':

$ref: '#/components/responses/InternalServerError'

post:

summary: Create Pricing

description: |

Change a new pricing to use as default (for cloud providers that Cost Advisor doesn't automatically support) or for a specific Kubernetes cluster.\

\

You need to specify hourly costs for 1 CPU, 1GB of RAM and 1GB of storage. \

Different CPU and RAM costs can be specified for spot instances; to enable Cost Advisor to identify the spot node, a label and spot value must also be set. \

\

Cluster hourly cost = sum(node hourly costs) + (total storage * storage unit cost). \

Node hourly cost = (total CPUs * CPU unit cost) + (total RAM * RAM unit cost) \

\

**Required permissions:** _cost-advisor.edit_

operationId: createPricingV1

tags:

- Cost Advisor Custom Pricing

requestBody:

description: The payload to create pricing. Use the type field to create a default pricing or pricing for a specific Kubernetes cluster.

content:

application/json:

schema:

$ref: '#/components/schemas/CreatePricingRequestV1'

responses:

'201':

description: Pricing created.

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

content:

application/json:

schema:

$ref: '#/components/schemas/PricingResponseV1'

'400':

$ref: '#/components/responses/BadRequest'

'401':

$ref: '#/components/responses/Unauthorized'

'409':

$ref: '#/components/responses/Conflict'

'415':

$ref: '#/components/responses/UnsupportedMediaType'

'422':

$ref: '#/components/responses/UnprocessableEntity'

'429':

$ref: '#/components/responses/TooManyRequests'

'500':

$ref: '#/components/responses/InternalServerError'

/monitor/cost-advisor/v1/pricing/{pricingId}:

x-excluded-environments:

- OnPrem

get:

summary: Get Pricing

description: |

Retrieve a pricing by ID.\

\

**Required permissions:** _cost-advisor.read_

operationId: getPricingByIdV1

tags:

- Cost Advisor Custom Pricing

parameters:

- $ref: '#/components/parameters/PricingIdPath'

responses:

'200':

description: Pricing found.

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

content:

application/json:

schema:

$ref: '#/components/schemas/PricingResponseV1'

'400':

$ref: '#/components/responses/BadRequest'

'401':

$ref: '#/components/responses/Unauthorized'

'404':

$ref: '#/components/responses/NotFound'

'429':

$ref: '#/components/responses/TooManyRequests'

'500':

$ref: '#/components/responses/InternalServerError'

put:

summary: Update Pricing

description: |

The pricing payload containing the changes you want to apply to the pricing.\

\

**Required permissions:** _cost-advisor.edit_

operationId: updatePricingByIdV1

tags:

- Cost Advisor Custom Pricing

parameters:

- $ref: '#/components/parameters/PricingIdPath'

requestBody:

description: The payload required to create the pricing.

content:

application/json:

schema:

$ref: '#/components/schemas/UpdatePricingRequestV1'

responses:

'200':

description: Pricing updated.

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

content:

application/json:

schema:

$ref: '#/components/schemas/PricingResponseV1'

'400':

$ref: '#/components/responses/BadRequest'

'401':

$ref: '#/components/responses/Unauthorized'

'404':

$ref: '#/components/responses/NotFound'

'409':

$ref: '#/components/responses/Conflict'

'415':

$ref: '#/components/responses/UnsupportedMediaType'

'422':

$ref: '#/components/responses/UnprocessableEntity'

'429':

$ref: '#/components/responses/TooManyRequests'

'500':

$ref: '#/components/responses/InternalServerError'

delete:

summary: Delete Pricing

description: |

Delete a pricing by its ID. If the pricing deleted is the DEFAULT one. Cost Advisor will continue to compute costs for the unsupported Kubernetes cluster using the Sysdig default pricing.\

\

**Required permissions:** _cost-advisor.edit_

operationId: deletePricingByIdV1

tags:

- Cost Advisor Custom Pricing

parameters:

- $ref: '#/components/parameters/PricingIdPath'

responses:

'204':

description: Pricing deleted.

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

'400':

$ref: '#/components/responses/BadRequest'

'401':

$ref: '#/components/responses/Unauthorized'

'403':

$ref: '#/components/responses/Forbidden'

'404':

$ref: '#/components/responses/NotFound'

'422':

$ref: '#/components/responses/UnprocessableEntity'

'429':

$ref: '#/components/responses/TooManyRequests'

'500':

$ref: '#/components/responses/InternalServerError'

/monitor/cost-advisor/v1/pricing/{pricingId}/projected-costs:

x-excluded-environments:

- OnPrem

get:

summary: Get Pricing Projected Costs

description: |

Retrieve the monthly projected costs for the clusters using the specified pricing.\

The computation is done using the total CPU and RAM for the current cluster's nodes and the total storage used by the cluster.\

\

Projected monthly cost = 730 * (total CPUs * CPU unit cost) + (total RAM * RAM unit cost) + (total storage * storage unit cost). \

\

**Required permissions:** _cost-advisor.read_

operationId: getPricingProjectedCostsV1

tags:

- Cost Advisor Custom Pricing

parameters:

- $ref: '#/components/parameters/PricingIdPath'

- $ref: '#/components/parameters/Offset'

- $ref: '#/components/parameters/Limit'

responses:

'200':

description: Montlhy projected costs.

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

content:

application/json:

schema:

$ref: '#/components/schemas/GetPricingProjectedPaginatedResponseV1'

'400':

$ref: '#/components/responses/BadRequest'

'401':

$ref: '#/components/responses/Unauthorized'

'404':

$ref: '#/components/responses/NotFound'

'429':

$ref: '#/components/responses/TooManyRequests'

'500':

$ref: '#/components/responses/InternalServerError'

/monitor/cost-advisor/v1alpha1/data/workload-cost-trends:

x-excluded-environments:

- OnPrem

post:

summary: Workload Cost Trends Data

description: |

Returns workload cost trends data for a specified trend range, pivot date, optional scope,

and optional grouping. The response includes cost totals for both current

and previous periods, along with the date ranges for each period.

operationId: getWorkloadCostDataV1

tags:

- Cost Advisor Data

requestBody:

required: true

content:

application/json:

schema:

$ref: '#/components/schemas/WorkloadCostTrendsDataRequest'

responses:

'200':

description: Workload Cost Trend data

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

content:

application/json:

schema:

$ref: '#/components/schemas/WorkloadCostTrendsDataResponse'

'400':

$ref: '#/components/responses/BadRequest'

'401':

$ref: '#/components/responses/Unauthorized'

'429':

$ref: '#/components/responses/TooManyRequests'

'500':

$ref: '#/components/responses/InternalServerError'

/monitor/cost-advisor/v1alpha1/data/wasted-workload-spend:

x-excluded-environments:

- OnPrem

post:

summary: Wasted Workload Spend Data

description: |

Use this API to generate a report of Wasted Workload Spend data for a specified date range, scope,

and grouping. For details, see [Wasted Workload Spend Report](https://docs.sysdig.com/en/sysdig-monitor/cost-reports/#wasted-workload-spend-report).

operationId: getWastedWorkloadData

tags:

- Cost Advisor Data

requestBody:

required: true

content:

application/json:

schema:

$ref: '#/components/schemas/WastedWorkloadDataRequest'

responses:

'200':

description: Wasted Workload Spend data

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

content:

application/json:

schema:

$ref: '#/components/schemas/WastedWorkloadSpendDataResponse'

'400':

$ref: '#/components/responses/BadRequest'

'401':

$ref: '#/components/responses/Unauthorized'

'429':

$ref: '#/components/responses/TooManyRequests'

'500':

$ref: '#/components/responses/InternalServerError'

/monitor/cost-advisor/v1alpha1/data/workload-rightsizing:

x-excluded-environments:

- OnPrem

post:

summary: Workload Rightsizing Data

description: "Use this API to generate a Workload Rightsizing data for a specified date range, algorithm and optional scope. \nThe response is automatically grouped by the following Prometheus labels:\n - kube_cluster_name\n - kube_namespace_name\n - kube_workload_name\n - container_name\n"

operationId: getWorkloadRightsizingData

tags:

- Cost Advisor Data

requestBody:

required: true

content:

application/json:

schema:

$ref: '#/components/schemas/WorkloadRightsizingDataRequest'

responses:

'200':

description: Workload Rightsizing data

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

content:

application/json:

schema:

$ref: '#/components/schemas/WorkloadRightsizingDataResponse'

'400':

$ref: '#/components/responses/BadRequest'

'401':

$ref: '#/components/responses/Unauthorized'

'429':

$ref: '#/components/responses/TooManyRequests'

'500':

$ref: '#/components/responses/InternalServerError'

/monitor/alerts/v1/inhibition-rules:

get:

summary: List Inhibition Rules

description: |

Retrieve the list of inhibition rules.\

\

**Required permissions:** _inhibition-rules.read_ or _alerts.read_

operationId: getInhibitionRules

tags:

- Inhibition Rules

parameters:

- $ref: '#/components/parameters/Offset'

- $ref: '#/components/parameters/Limit'

responses:

'200':

description: The list of inhibition rules.

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

content:

application/json:

schema:

$ref: '#/components/schemas/GetInhibitionRulesPaginatedResponseV1'

'400':

$ref: '#/components/responses/BadRequest'

'401':

$ref: '#/components/responses/Unauthorized'

'429':

$ref: '#/components/responses/TooManyRequests'

'500':

$ref: '#/components/responses/InternalServerError'

post:

summary: Create Inhibition Rule

description: |

Create an inhibition rule.\

\

**Required permissions:** _inhibition-rules.edit_ or _alerts.edit_

operationId: createInhibitionRule

tags:

- Inhibition Rules

requestBody:

description: The inhibition rule to be created.

required: true

content:

application/json:

schema:

$ref: '#/components/schemas/CreateInhibitionRuleRequestV1'

responses:

'201':

description: Inhibition rule created.

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

content:

application/json:

schema:

$ref: '#/components/schemas/InhibitionRuleResponseV1'

'400':

$ref: '#/components/responses/BadRequest'

'401':

$ref: '#/components/responses/Unauthorized'

'403':

$ref: '#/components/responses/Forbidden'

'415':

$ref: '#/components/responses/UnsupportedMediaType'

'422':

$ref: '#/components/responses/UnprocessableEntity'

'429':

$ref: '#/components/responses/TooManyRequests'

'500':

$ref: '#/components/responses/InternalServerError'

/monitor/alerts/v1/inhibition-rules/{inhibitionRuleId}:

get:

summary: Get Inhibition Rule

description: |

Retrieve an inhibition rule by ID.\

\

**Required permissions:** _inhibition-rules.read_ or _alerts.read_

operationId: getInhibitionRuleById

tags:

- Inhibition Rules

parameters:

- $ref: '#/components/parameters/InhibitionRulePath'

responses:

'200':

description: Inhibition rule found.

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

content:

application/json:

schema:

$ref: '#/components/schemas/InhibitionRuleResponseV1'

'400':

$ref: '#/components/responses/BadRequest'

'401':

$ref: '#/components/responses/Unauthorized'

'404':

$ref: '#/components/responses/NotFound'

'429':

$ref: '#/components/responses/TooManyRequests'

'500':

$ref: '#/components/responses/InternalServerError'

put:

summary: Update Inhibition Rule

description: |

Update an inhibition rule.\

\

**Required permissions:** _inhibition-rules.edit_ or _alerts.edit_

operationId: updateInhibitionRule

tags:

- Inhibition Rules

parameters:

- $ref: '#/components/parameters/InhibitionRulePath'

requestBody:

description: The new version of the inhibition rule.

required: true

content:

application/json:

schema:

$ref: '#/components/schemas/UpdateInhibitionRuleRequestV1'

responses:

'200':

description: Inhibition rule updated.

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

content:

application/json:

schema:

$ref: '#/components/schemas/InhibitionRuleResponseV1'

'400':

$ref: '#/components/responses/BadRequest'

'401':

$ref: '#/components/responses/Unauthorized'

'404':

$ref: '#/components/responses/NotFound'

'409':

$ref: '#/components/responses/Conflict'

'415':

$ref: '#/components/responses/UnsupportedMediaType'

'422':

$ref: '#/components/responses/UnprocessableEntity'

'429':

$ref: '#/components/responses/TooManyRequests'

'500':

$ref: '#/components/responses/InternalServerError'

delete:

summary: Delete Inhibition Rule

description: |

Delete an inhibition rule by its ID.\

\

**Required permissions:** _inhibition-rules.edit_ or _alerts.edit_

operationId: deleteInhibitionRuleById

tags:

- Inhibition Rules

parameters:

- $ref: '#/components/parameters/InhibitionRulePath'

responses:

'204':

description: Inhibition rule deleted.

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

'400':

$ref: '#/components/responses/BadRequest'

'401':

$ref: '#/components/responses/Unauthorized'

'404':

$ref: '#/components/responses/NotFound'

'429':

$ref: '#/components/responses/TooManyRequests'

'500':

$ref: '#/components/responses/InternalServerError'

/monitor/events/v1/events:

get:

summary: Get Events

operationId: getMonitorEventsV1

description: "Retrieves the list of events matching the expressed search criteria.\nThe pair `from` and `to` and the `cursor` parameter are mutually exclusive. If you supply a `from` and `to` you must not supply a `cursor` and vice-versa.\nThe time criteria is required and can be specified in two different ways:\n- Using `from` and `to`, the list of events within the timeframe (max 2 weeks) will be returned, starting from the most recent ones.\n- Using a `cursor` the events returned will be in the before or after the event, depending on the cursor type. More details are available in the `cursor` attribute in the response.\\\n\\\n**Required permissions:** \n- _alert-events.read_ for alert events to be included in the response\n- _custom-events.read_ for custom events to be included in the response\n"

tags:

- Monitor Events

parameters:

- in: query

name: from

schema:

$ref: '#/components/schemas/MonitorEventsFrom'

- in: query

name: to

schema:

$ref: '#/components/schemas/MonitorEventsTo'

- in: query

name: cursor

schema:

$ref: '#/components/schemas/MonitorEventsCursor'

- in: query

name: filter

schema:

$ref: '#/components/schemas/MonitorEventsFilter'

- $ref: '#/components/parameters/Limit'

responses:

'200':

description: The list of events.

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

content:

application/json:

schema:

$ref: '#/components/schemas/ListMonitorEventsResponse'

'400':

description: Bad request

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

content:

application/json:

schema:

$ref: '#/components/schemas/Error'

'401':

$ref: '#/components/responses/Unauthorized'

'403':

$ref: '#/components/responses/Forbidden'

'404':

$ref: '#/components/responses/NotFound'

'429':

$ref: '#/components/responses/TooManyRequests'

'500':

$ref: '#/components/responses/InternalServerError'

/monitor/prometheus-jobs/v1/disabled-metrics:

get:

summary: List disabled metrics collection for Jobs.

description: |

List all disabled metrics per Job.\

\

**Required permissions:** Integrations Read

operationId: getDisabledMetricsByJobV1

tags:

- Metrics Collection

parameters:

- name: jobName

in: query

description: |

The name of the Prometheus Job whose excluded metrics are to be listed.

required: false

schema:

type: string

example: job-name-default

maxLength: 256

- name: metricName

in: query

description: |

The exact name of the metric to be filtered.

required: false

schema:

type: string

example: apache_accesses_total

maxLength: 256

responses:

'200':

description: The list of disabled metrics associated with the specified Job.

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

content:

application/json:

schema:

$ref: '#/components/schemas/ResponseListDisabledMetricsV1'

'400':

$ref: '#/components/responses/BadRequest'

'401':

$ref: '#/components/responses/Unauthorized'

'404':

$ref: '#/components/responses/NotFound'

'429':

$ref: '#/components/responses/TooManyRequests'

'500':

$ref: '#/components/responses/InternalServerError'

post:

summary: Disable or re-enable metrics collection for Jobs

description: |

Disable specific metric collection for a specified Job. \

This API supports specifying multiple Jobs, each with its own list of metrics to be disabled. \

Additionally, you can use the same API to re-enable metrics that were previously disabled.\

\

**Required permissions:** Integrations Full Access

operationId: postDisabledMetricsV1

tags:

- Metrics Collection

requestBody:

content:

application/json:

schema:

$ref: '#/components/schemas/RequestBodyDisabledMetricsV1'

responses:

'200':

description: All Jobs and metrics have been disabled/re-enabled successfully.

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

content:

application/json:

schema:

$ref: '#/components/schemas/ResponseListDisabledMetricsV1'

'207':

description: Some metrics could not be disabled/re-enabled. Check the error information for further explanation.

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

content:

application/json:

schema:

$ref: '#/components/schemas/ResponseListDisabledMetricsAndErrorV1'

'400':

$ref: '#/components/responses/BadRequest'

'401':

$ref: '#/components/responses/Unauthorized'

'404':

$ref: '#/components/responses/NotFound'

'429':

$ref: '#/components/responses/TooManyRequests'

'500':

$ref: '#/components/responses/InternalServerError'

/monitor/prometheus-jobs/v1alpha1/custom-jobs:

get:

summary: List Custom Prometheus jobs

description: |

Retrieve a paginated list of custom Prometheus jobs.\

\

**Required permissions:** _promcat.integrations.read_

operationId: getCustomPrometheusJobsV1

tags:

- Metrics Collection

parameters:

- $ref: '#/components/parameters/Offset'

- $ref: '#/components/parameters/Limit'

responses:

'200':

description: The custom jobs page.

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

content:

application/json:

schema:

$ref: '#/components/schemas/GetCustomJobsPaginatedResponseV1'

'400':

$ref: '#/components/responses/BadRequest'

'401':

$ref: '#/components/responses/Unauthorized'

'404':

$ref: '#/components/responses/NotFound'

'429':

$ref: '#/components/responses/TooManyRequests'

'500':

$ref: '#/components/responses/InternalServerError'

/monitor/prometheus-jobs/v1alpha1/custom-jobs/{jobName}:

post:

summary: Create Custom Prometheus job

description: "Create a custom Prometheus job. \n\\\nThe body of the request must be a valid `scrape_config` as defined here: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config\\\n\\\nThe custom job will be disabled by default and must be enabled with the `/monitor/prometheus-jobs/v1alpha1/custom-jobs/{jobName}/enablement` api.\n\\\nYou can override the standard Sysdig integration jobs using the same job name. The job names are available here: https://docs.sysdig.com/en/docs/sysdig-monitor/integrations/monitoring-integrations/configure-default-integrations/#supported-monitoring-integrations\n\\\n**CAUTION**: the content of the job must be validated according to the Prometheus Scrape Config job definition. Any misconfiguration here can lead the Agent to fail the job parsing and stop sending custom metrics for all jobs.\n\\\n**Required permissions:** _promcat.integrations.admin_\n"

operationId: createCustomPrometheusJobV1

tags:

- Metrics Collection

parameters:

- $ref: '#/components/parameters/JobNamePath'

requestBody:

description: The payload to create a custom job. Content must be a valid Prometheus `scrape_config`.

content:

application/yaml:

schema:

$ref: '#/components/schemas/CustomJobContentV1'

responses:

'201':

description: Custom Prometheus job created.

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

content:

application/yaml:

schema:

$ref: '#/components/schemas/CustomJobContentV1'

'400':

$ref: '#/components/responses/BadRequest'

'401':

$ref: '#/components/responses/Unauthorized'

'409':

$ref: '#/components/responses/Conflict'

'415':

$ref: '#/components/responses/UnsupportedMediaType'

'422':

$ref: '#/components/responses/UnprocessableEntity'

'429':

$ref: '#/components/responses/TooManyRequests'

'500':

$ref: '#/components/responses/InternalServerError'

get:

summary: Get Custom Prometheus Job

description: |

Retrieve a custom Prometheus job by its name.\

\

**Required permissions:** _promcat.integrations.read_

operationId: getCustomPrometheusJobByNameV1

tags:

- Metrics Collection

parameters:

- $ref: '#/components/parameters/JobNamePath'

responses:

'200':

description: Custom Prometheus Job found.

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

content:

application/yaml:

schema:

$ref: '#/components/schemas/CustomJobContentV1'

'400':

$ref: '#/components/responses/BadRequest'

'401':

$ref: '#/components/responses/Unauthorized'

'404':

$ref: '#/components/responses/NotFound'

'429':

$ref: '#/components/responses/TooManyRequests'

'500':

$ref: '#/components/responses/InternalServerError'

put:

summary: Update Custom Prometheus Job

description: "Update a custom Prometheus job. \n\\\nThe body of the request must be a valid `scrape_config` as defined here: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config\\\n\\\nYou can override the standard Sysdig integration jobs using the same job name. The job names are available here: https://docs.sysdig.com/en/docs/sysdig-monitor/integrations/monitoring-integrations/configure-default-integrations/#supported-monitoring-integrations\n\\\n**CAUTION**: the content of the job must be validated according to the Prometheus Scrape Config job definition. Any misconfiguration here can lead the Agent to fail the job parsing and stop sending custom metrics for all jobs.\n\\\n**Required permissions:** _promcat.integrations.admin_\n"

operationId: updateCustomPrometheusJobByIdV1

tags:

- Metrics Collection

parameters:

- $ref: '#/components/parameters/JobNamePath'

requestBody:

description: The custom Prometheus job yaml content

content:

application/yaml:

schema:

$ref: '#/components/schemas/CustomJobContentV1'

responses:

'200':

description: Custom Prometheus job updated.

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

content:

application/yaml:

schema:

$ref: '#/components/schemas/CustomJobContentV1'

'400':

$ref: '#/components/responses/BadRequest'

'401':

$ref: '#/components/responses/Unauthorized'

'404':

$ref: '#/components/responses/NotFound'

'409':

$ref: '#/components/responses/Conflict'

'415':

$ref: '#/components/responses/UnsupportedMediaType'

'422':

$ref: '#/components/responses/UnprocessableEntity'

'429':

$ref: '#/components/responses/TooManyRequests'

'500':

$ref: '#/components/responses/InternalServerError'

delete:

summary: Delete Custom Prometheus job

description: |

Delete a custom Prometheus job by its name.\

\

**Required permissions:** _promcat.integrations.admin_

operationId: deleteCustomPrometheusJobByIdV1

tags:

- Metrics Collection

parameters:

- $ref: '#/components/parameters/JobNamePath'

responses:

'204':

description: Custom Prometheus job deleted.

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32

minimum: 1

maximum: 4096

'400':

$ref: '#/components/responses/BadRequest'

'401':

$ref: '#/components/responses/Unauthorized'

'403':

$ref: '#/components/responses/Forbidden'

'404':

$ref: '#/components/responses/NotFound'

'422':

$ref: '#/components/responses/UnprocessableEntity'

'429':

$ref: '#/components/responses/TooManyRequests'

'500':

$ref: '#/components/responses/InternalServerError'

/monitor/prometheus-jobs/v1alpha1/custom-jobs/{jobName}/enablement:

get:

summary: Get Custom Prometheus Job enablement

description: |

Retrieve the enablement state of a custom Prometheus job by its name.\

\

**Required permissions:** _promcat.integrations.admin_

operationId: getCustomPrometheusJobEnablementV1

tags:

- Metrics Collection

parameters:

- $ref: '#/components/parameters/JobNamePath'

responses:

'200':

description: Custom Prometheus job found.

headers:

X-RateLimit-Limit:

description: Maximum number of allowed requests per minute.

schema:

type: integer

format: int32