getGuidelines

Get all available guidelines for an org with filtering, sorting, and pagination.

Examples

GraphQL

query GetGuidelines($input: GetGuidelinesInput) {
  getGuidelines(input: $input) {
    items {
      _id
      oxGuidelineId
      languages
      displayName
      description
      status
      isEditable
      createdBy
      createdAt
      updatedBy
      updatedAt
      category
      isDeleted
      isReady
    }
    total
  }
}

Variables

This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.

{
  "input": {
    "filter": {
      "categoryIds": ["ThreatIntelligence"],
      "languages": ["Python"],
      "createdBy": ["[e-mail]"],
      "status": ["Enabled"],
      "search": "sql injection"
    },
    "sort": {
      "field": "DisplayName",
      "order": "Asc"
    },
    "limit": 100,
    "offset": 0
  }
}

cURL

curl -X POST \
https://api.cloud.ox.security/api/apollo-gateway \
-H 'Content-Type: application/json' \
-H 'Authorization: YOUR_API_TOKEN' \
-d '{
 "query": "query GetGuidelines($input: GetGuidelinesInput) { getGuidelines(input: $input) { items { _id oxGuidelineId languages displayName description status isEditable createdBy createdAt updatedBy updatedAt category isDeleted isReady } total } }",
 "variables": {
    "input": {
      "filter": {
        "categoryIds": ["ThreatIntelligence"],
        "languages": ["Python"],
        "createdBy": ["[e-mail]"],
        "status": ["Enabled"],
        "search": "sql injection"
      },
      "sort": {
        "field": "DisplayName",
        "order": "Asc"
      },
      "limit": 100,
      "offset": 0
    }
  }
}'

Node.js

const query = 'query GetGuidelines($input: GetGuidelinesInput) { getGuidelines(input: $input) { items { _id oxGuidelineId languages displayName description status isEditable createdBy createdAt updatedBy updatedAt category isDeleted isReady } total } }';

fetch("https://api.cloud.ox.security/api/apollo-gateway", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  body: JSON.stringify({
    query: query,
    // This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    variables: {
      input: {
        filter: {
          categoryIds: ["ThreatIntelligence"],
          languages: ["Python"],
          createdBy: ["[e-mail]"],
          status: ["Enabled"],
          search: "sql injection"
        },
        sort: {
          field: "DisplayName",
          order: "Asc"
        },
        limit: 100,
        offset: 0
      }
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

Python

import requests

query = 'query GetGuidelines($input: GetGuidelinesInput) { getGuidelines(input: $input) { items { _id oxGuidelineId languages displayName description status isEditable createdBy createdAt updatedBy updatedAt category isDeleted isReady } total } }'

response = requests.post(
  "https://api.cloud.ox.security/api/apollo-gateway",
  headers={
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  json={
    "query": query,
    # This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    "variables": {
      "input": {
        "filter": {
          "categoryIds": ["ThreatIntelligence"],
          "languages": ["Python"],
          "createdBy": ["[e-mail]"],
          "status": ["Enabled"],
          "search": "sql injection"
        },
        "sort": {
          "field": "DisplayName",
          "order": "Asc"
        },
        "limit": 100,
        "offset": 0
      }
    }
  }
)

if response.status_code == 200:
    result = response.json()
    print(result)
else:
    print(f"Error: {response.status_code}")
    print(response.text)

Arguments

You can use the following argument(s) to customize your getGuidelines query.

Argument	Description	Supported fields
input GetGuidelinesInput	Input object for filtering, sorting, and pagination	filter GuidelineFilterInput sort GuidelineSortInput limit Int offset Int

Fields

Return type: GetGuidelinesResponse!

You can use the following field(s) to specify what information your getGuidelines query will return. Please note that some fields may have their own subfields.

Field	Description	Supported fields
items [GuidelineSummary!]!	List of guidelines	_id String! oxGuidelineId String languages [GuidelineLanguage!]! displayName String! description String status GuidelineStatus! isEditable Boolean! createdBy String! createdAt DateTime! updatedBy String! updatedAt DateTime! category CategoryId! isDeleted Boolean! isReady Boolean!
data [GuidelineSummary!]! ⚠️	Deprecated: Use items	_id String! oxGuidelineId String languages [GuidelineLanguage!]! displayName String! description String status GuidelineStatus! isEditable Boolean! createdBy String! createdAt DateTime! updatedBy String! updatedAt DateTime! category CategoryId! isDeleted Boolean! isReady Boolean!
total Float!	Total number of guidelines