itglue-endpoints.yml

# WARNING: None of the content here has been tested.
# Please validate everything yourself, and check it against
# the IT Glue documentation. https://api.itglue.com/developer/

related_items:
  endpoints:
  - /:id/:id/relationships/related_items
  - /:id/:id/relationships/related_items/:id
  methods:
  - DELETE
  - PATCH
  - POST
  allowed_parameters:
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        destination_id: int
        destination_type: string
        notes: string
        id: int
  returnbody:
    data:
    - type: string
      attributes:
        destination_id: int
        destination_type: string
        notes: string
        id: int

configurations:
  endpoints:
  - /configurations
  - /configurations/:id
  - /organizations/:id/relationships/configurations
  - /organizations/:id/relationships/configurations/:id
  methods:
  - DELETE
  - GET
  - PATCH
  - POST
  allowed_parameters:
  - filter[asset_tag]
  - filter[configuration_status_id]
  - filter[configuration_type_id]
  - filter[contact_id]
  - filter[id]
  - filter[name]
  - filter[organization_id]
  - filter[psa_id]
  - filter[psa_integration_type]
  - filter[rmm_id]
  - filter[rmm_integration_type]
  - filter[serial_number]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        id: int
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        organization-id: int
        organization-name: string
        resource-url: string
        name: string
        hostname: string
        primary-ip: int
        mac-address: int
        serial-number: string
        asset-tag: string
        position: string
        installed-by: string
        purchased-by: string
        notes: string
        operating-system-notes: string
        warranty-expires-at: datetime
        installed-at: datetime
        purchased-at: datetime
        created-at: datetime
        updated-at: datetime
        organization-short-name: string
        configuration-type-id: int
        configuration-type-name: string
        configuration-type-kind: string
        configuration-status-id: int
        configuration-status-name: string
        manufacturer-id: int
        manufacturer-name: string
        model-id: int
        model-name: string
        operating-system-id: int
        operating-system-name: string
        location-id: int
        location-name: string
      relationships:
        configuration-interfaces:
          data:
          - id: int
            type: string
  
accounts_users:
  endpoints:
  - /users
  - /users/:id
  methods:
  - GET
  - PATCH
  allowed_parameters:
  - filter[email]
  - filter[id]
  - filter[name]
  - filter[role_name]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        id: int
        first-name: string
        last-name: string
        avatar:
          content: string
          file_name: string
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        first-name: string
        last-name: string
        role-name: string
        email: string
        avatar: string
        invitation-sent-at: datetime
        invitation-accepted-at: datetime
        current-sign-in-at: datetime
        current-sign-in-ip: int
        last-sign-in-at: datetime
        last-sign-in-ip: int
        reputation: int
        my-glue: bool
        my-glue-account-id: string

attachments:
  endpoints:
  - /:id/:id/relationships/attachments
  - /:id/:id/relationships/attachments/:id
  methods:
  - DELETE
  - PATCH
  - POST
  allowed_parameters:
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        content: int
        file_name: string
  returnbody:
    data:
    - type: string
      attributes:
        id: int

groups:
  endpoints:
  - /groups
  - /groups/:id
  methods:
  - GET
  allowed_parameters:
  - filter[name]
  required_parameters:
  createbody:
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        name: string
        created-at: datetime
        updated-at: datetime

organization_types:
  endpoints:
  - /organization_types
  - /organization_types/:id
  methods:
  - GET
  - PATCH
  - POST
  allowed_parameters:
  - filter[name]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        name: string
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        name: string
        created-at: datetime
        updated-at: datetime

organizations:
  endpoints:
  - /organizations
  - /organizations/:id
  methods:
  - DELETE
  - GET
  - PATCH
  - POST
  allowed_parameters:
  - filter[created_at]
  - filter[exclude]
  - filter[exclude][id]
  - filter[exclude][name]
  - filter[exclude][organization_status_id]
  - filter[exclude][organization_type_id]
  - filter[group_id]
  - filter[id]
  - filter[my_glue_account_id]
  - filter[name]
  - filter[organization_status_id]
  - filter[organization_type_id]
  - filter[psa_id]
  - filter[psa_integration_type]
  - filter[range]
  - filter[range][my_glue_account_id]
  - filter[updated_at]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        name: string
        alert: string
        description: string
        organization-type-id: int
        organization-type-name: string
        organization-status-id: int
        organization-status-name: string
        primary: bool
        logo: string
        quick-notes: string
        short-name: string
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        name: string
        alert: string
        description: string
        organization-type-id: int
        organization-type-name: string
        organization-status-id: int
        organization-status-name: string
        primary: bool
        logo: string
        quick-notes: string
        short-name: string
        created-at: datetime
        updated-at: datetime

flexible_assets:
  endpoints:
  - /flexible_assets
  - /flexible_assets/:id
  methods:
  - DELETE
  - GET
  - PATCH
  - POST
  allowed_parameters:
  - filter[flexible_asset_type_id]
  - filter[name]
  - filter[organization_id]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        id: int
        organization-id: int
        traits:
          name-field: string
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        organization-id: int
        organization-name: string
        resource-url: string
        restricted: bool
        my-glue: bool
        flexible-asset-type-id: int
        flexible-asset-type-name: string
        name: string
        traits:
          # Backup, Disaster Recovery 
          backup-platform: string
          backup-description: string
          backup-technology: string
          next-verification: date
          backup-window: string
          backup-frequency: string
          local-location: string
          offsite-provider: string
          offsite-replication: string
          additional-details: string
          protected-servers:
            type: string
            values:
            - resource-url: string
              id: int
              name: string
              hostname: string
              organization-name: string
              configuration-type-name: string
          local-backup-server-s:
            type: string
            values:
            - resource-url: string
              id: int
              name: string
              hostname: string
              organization-name: string
              configuration-type-name: string
          who-approves-restore-requests:
            type: string
            values:
            - resource-url: string
              id: int
              first-name: string
              last-name: string
              organization-name: string
          # Used for "Device logbook - Autodoc"
          device-name: string
          events: string
          user-profiles: string
          installed-updates: string
          installed-software: string
          device: int
          # ADDS Documentation
          domain-name: string
          forest-summary: string
          site-summary: string
          domain-controllers: string
          fsmo-roles: string
          optional-features: string
          upn-suffixes: string
          default-password-policies: string
          domain-admins: string
          user-count: string
        created-at: datetime
        updated-at: datetime

manufacturers:
  endpoints:
  - /manufacturers
  - /manufacturers/:id
  methods:
  - GET
  - PATCH
  - POST
  allowed_parameters:
  - filter[name]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        name: string
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        name: string
        created-at: datetime
        updated-at: datetime

operating_systems:
  endpoints:
  - /operating_systems
  - /operating_systems/:id
  methods:
  - GET
  allowed_parameters:
  - filter[name]
  required_parameters:
  createbody:
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        name: string
        platform-id: int
        platform-name: string
        created-at: datetime
        updated-at: datetime

organization_statuses:
  endpoints:
  - /organization_statuses
  - /organization_statuses/:id
  methods:
  - GET
  - PATCH
  - POST
  allowed_parameters:
  - filter[name]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        name: string
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        name: string
        created-at: datetime
        updated-at: datetime
        
passwords:
  endpoints:
  - /passwords
  - /passwords/:id
  - /organizations/:id/relationships/passwords
  - /organizations/:id/relationships/passwords/:id
  methods:
  - DELETE
  - GET
  - PATCH
  - POST
  allowed_parameters:
  - filter[cached_resource_name]
  - filter[id]
  - filter[name]
  - filter[organization_id]
  - filter[password_category_id]
  - filter[url]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        id: int
        name: string
        username: string
        password: string
        url: string
        notes: string
        resource_id: int
        resource_type: string
        password-category-id: int
        password-category-name: string
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        organization-id: int
        organization-name: string
        resource-url: string
        restricted: bool
        my-glue: bool
        name: string
        autofill-selectors: string
        username: string
        password: string
        url: string
        notes: string
        password-updated-at: datetime
        updated-by: int
        resource-id: int
        resource-type: string
        cached-resource-type-name: string
        cached-resource-name: string
        password-category-id: int
        password-category-name: string
        created-at: datetime
        updated-at: datetime
  requestbodyError:

accounts_user_metrics_daily:
  endpoints:
  - /user_metrics
  methods:
  - GET
  allowed_parameters:
  - filter[date]
  - filter[organization_id]
  - filter[resource_type]
  - filter[user_id]
  required_parameters:
  createbody:
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        user-id: int
        organization-id: int
        resource-type: string
        created: int
        viewed: int
        edited: int
        deleted: int
        date: date
contacts:
  endpoints:
  - /contacts
  - /contacts/:id
  methods:
  - DELETE
  - GET
  - PATCH
  - POST
  allowed_parameters:
  - filter[contact_type_id]
  - filter[first_name]
  - filter[id]
  - filter[important]
  - filter[last_name]
  - filter[organization_id]
  - filter[primary_email]
  - filter[psa_id]
  - filter[psa_integration_type]
  - filter[title]
  required_parameters:
  createbody:
    data:
    - id: int
      type: string
      attributes:
        organization-id: int
        organization-name: string
        name: string
        first-name: string
        last-name: string
        title: string
        contact-type-id: int
        contact-type-name: string
        location-id: int
        location-name: string
        important: string
        notes: string
        contact-emails:
        - value: string
          primary: bool
          label-name: string
        contact-phones:
        - value: int
          extension: string
          primary: bool
          label-name: string
          label-type: string
          formatted-value: (415) 555-2156
      relationships:
        attachments:
          data:
          - id: int
            type: string
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        organization-id: int
        organization-name: string
        name: string
        first-name: string
        last-name: string
        title: string
        contact-type-id: int
        contact-type-name: string
        location-id: int
        location-name: string
        important: string
        notes: string
        created-at: datetime
        updated-at: datetime
        contact-emails:
        - value: string
          primary: bool
          label-name: string
        contact-phones:
        - value: string
          extension: string
          primary: bool
          label-name: string
          label-type: string
          formatted-value: string
      relationships:
        attachments:
          data:
          - id: int
            type: string
      included:
      - id: int
        type: string
        attributes:
          name: string
          attachment-file-name: string
          attachment-content-type: string
          attachment-file-size: int
          ext: string
          viewable: bool
          download-url: string
          created-at: datetime
          updated-at: datetime

configuration_interfaces:
  endpoints:
  - /configuration_interfaces
  - /configuration_interfaces/:id
  - /configurations/:id/relationships/configuration_interfaces
  methods:
  - GET
  - PATCH
  - POST
  allowed_parameters:
  - filter[id]
  - filter[ip_address]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        primary: bool
        name: string
        ip-address: int
        mac-address: string
  returnbody:
    data:
    - type: string
      attributes:
        primary: bool
        name: string
        ip-address: int
        mac-address: string
        notes: string
        id: int
        created-at: datetime
        updated-at: datetime
  requestbodyError:

configuration_statuses:
  endpoints:
  - /configuration_statuses
  - /configuration_statuses/:id
  methods:
  - GET
  - PATCH
  - POST
  allowed_parameters:
  - filter[name]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        name: string
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        name: string
        created-at: datetime
        updated-at: datetime

configuration_types:
  endpoints:
  - /configuration_types
  - /configuration_types/:id
  methods:
  - GET
  - PATCH
  - POST
  allowed_parameters:
  - filter[name]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        name: string
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        name: string
        configurations-count: int
        created-at: datetime
        updated-at: datetime

contact_types:
  endpoints:
  - /contact_types
  - /contact_types/:id
  methods:
  - GET
  - PATCH
  - POST
  allowed_parameters:
  - filter[name]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        name: string
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        name: string
        created-at: datetime
        updated-at: datetime

countries:
  endpoints:
  - /countries
  - /countries/:id
  methods:
  - GET
  allowed_parameters:
  - filter[iso]
  - filter[name]
  required_parameters:
  createbody:
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        name: string
        iso: string

domains:
  endpoints:
  - /domains
  methods:
  - GET
  allowed_parameters:
  - filter[id]
  - filter[organization_id]
  required_parameters:
  createbody:
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        organization-id: int
        organization-name: string
        resource-url: string
        name: string
        screenshot: /system/domains/screenshots/000/000/003/thumb/httphappyfrogcom.png?1488587288
        registrar-name: string
        notes: string
        expires-on: int
        updated-at: datetime

expirations:
  endpoints:
  - /expirations
  - /expirations/:id
  methods:
  - GET
  allowed_parameters:
  - filter[description]
  - filter[expiration_date]
  - filter[id]
  - filter[organization_id]
  - filter[range]
  - filter[range][expiration_date]
  - filter[resource_id]
  - filter[resource_name]
  - filter[resource_type_name]
  required_parameters:
  createbody:
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        organization-id: int
        organization-name: string
        resource-url: string
        description: string
        expiration-date: date
        created-at: datetime
        updated-at: datetime
        resource-id: int
        resource-type: string
        resource-type-name: string
        resource-name: string

flexible_asset_fields:
  endpoints:
  - /flexible_asset_fields
  - /flexible_asset_fields/:id
  - /flexible_asset_types/:id/relationships/flexible_asset_fields
  methods:
  - DELETE
  - GET
  - PATCH
  - POST
  allowed_parameters:
  - filter[id]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        id: int
        order: int
        name: string
        kind: string
        hint: string
        default-value: string
        use-for-title: bool
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        flexible-asset-type-id: int
        order: int
        name: string
        kind: string
        hint: string
        decimals: int
        default-value: string
        tag-type: string
        required: bool
        use-for-title: bool
        expiration: bool
        show-in-list: bool
        name-key: string
        created-at: datetime
        updated-at: datetime
      relationships:
        flexible-asset-type:
          data:
          - id: int
            type: string

flexible_asset_types:
  endpoints:
  - /flexible_asset_types
  - /flexible_asset_types/:id
  methods:
  - GET
  - PATCH
  - POST
  allowed_parameters:
  - filter[enabled]
  - filter[icon]
  - filter[id]
  - filter[name]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        name: string
        description: string
        icon: string
        show-in-menu: bool
      relationships:
        flexible-asset-fields:
          data:
          - type: string
            attributes:
              order: int
              name: string
              kind: string
              hint: string
              tag-type: string
              required: bool
              options: string
              use-for-title: bool
              show-in-list: bool
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        name: string
        description: string
        created-at: datetime
        updated-at: datetime
        icon: string
        show-in-menu: bool
      relationships:
        flexible-asset-fields:
          data:
          - id: int
            type: string

locations:
  endpoints:
  - /locations
  - /locations/:id
  - /organizations/:id/relationships/locations
  methods:
  - DELETE
  - GET
  - PATCH
  - POST
  allowed_parameters:
  - filter[city]
  - filter[country_id]
  - filter[id]
  - filter[name]
  - filter[organization_id]
  - filter[psa_id]
  - filter[psa_integration_type]
  - filter[region_id]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        id: int
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        organization-id: int
        organization-name: string
        name: string
        primary: bool
        address-1: int
        address-2: string
        city: string
        postal-code: int
        region-id: int
        region-name: string
        country-id: int
        country-name: string
        phone: int
        fax: int
        notes: string
        created-at: datetime
        updated-at: datetime
        formatted-phone: (415) 213-2000
        formatted-fax: (415) 213-2004

models:
  endpoints:
  - /models
  - /models/:id
  methods:
  - GET
  - PATCH
  - POST
  allowed_parameters:
  - filter[id]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        id: int
        name: string
        manufacturer-id: int
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        name: string
        manufacturer-id: int
        manufacturer-name: string
        created-at: datetime
        updated-at: datetime

regions:
  endpoints:
  - /regions
  - /regions/:id
  methods:
  - GET
  allowed_parameters:
  - filter[country_id]
  - filter[iso]
  - filter[name]
  required_parameters:
  createbody:
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        name: string
        iso: string
        country-id: int

password_categories:
  endpoints:
  - /password_categories
  - /password_categories/:id
  methods:
  - GET
  - PATCH
  - POST
  allowed_parameters:
  - filter[name]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        name: string
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        name: string
        created-at: datetime
        updated-at: datetime
        passwords-count: int

platforms:
  endpoints:
  - /platforms
  - /platforms/:id
  methods:
  - GET
  allowed_parameters:
  - filter[name]
  required_parameters:
  createbody:
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        name: string
        created-at: datetime
        updated-at: datetime